Skip to content
One-Shot
/
Enterprise Documentation
/
/Video ID

Oneshot API (1.0.0)

One-Shot API for single-use certificate electronic signatures. All endpoints are relative to the base path /oneshot/api/v1.

For the public testing environment (sandbox URL, RAO token, prerequisites, and how to use the test Optimizer), see the Get started guide in the One-Shot documentation: Get started with One-Shot.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Public testing environment

https://optimizer-developers.uanataca.com/oneshot/api/v1/

Settings

Endpoints to manage the service settings

Operations

Tokens

Endpoints to manage the tokens

Operations

Requests

Endpoints to manage the signature requests

Operations

Documents

Endpoints to manage the documents

Operations

Images

Endpoints to manage the images

Operations

Video ID

Endpoints to manage the Video ID

Operations

Call Create Videoid

Request

Create a VideoID

Bodyapplication/json
mobile_phone_numberstringrequired

The signer's mobile phone number

emailstringrequired

The signer's email

registration_authoritystringrequired

The Registration Authority ID number

profilestringrequired

The certificate profile

billing_usernamestringrequired

⚠ Required only if not set at settings.toml file. See Update Settings endpoint.

billing_passwordstringrequired

⚠ Required only if not set at settings.toml file. See Update Settings endpoint.

envstringrequired

⚠ Required only if not set at settings.ini file. See Update Settings endpoint.

Enum"sandbox""prod"
curl -i -X POST \
  https://optimizer-developers.uanataca.com/oneshot/api/v1/api/v1/videoid \
  -H 'Content-Type: application/json' \
  -d '{
    "mobile_phone_number": "string",
    "email": "string",
    "registration_authority": "string",
    "profile": "string",
    "billing_username": "string",
    "billing_password": "string",
    "env": "sandbox"
  }'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
{
  "status": "success",
  "messsage": "VideoID created with pk 16673",
  "detail": {
    "videoid_link": 16673,
    "request_pk": 923056
  }
}

Call Validate Videoid

Request

Validate a VideoID

Path
videoid_pkinteger(ID of the VideoID to validate)required

ID of the VideoID to validate

curl -i -X POST \
  'https://optimizer-developers.uanataca.com/oneshot/api/v1/api/v1/videoid/{videoid_pk}/validate'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
{
  "status": "success",
  "message": "VideoID validated"
}

Call Approve Videoid

Request

Approve a VideoID

Path
videoid_pkinteger(ID of the VideoID to approve)required

ID of the VideoID to approve

curl -i -X POST \
  'https://optimizer-developers.uanataca.com/oneshot/api/v1/api/v1/videoid/{videoid_pk}/approve'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
{
  "status": "success",
  "message": "VideoID approved"
}

Call Refuse Videoid

Request

Refuse a VideoID

Path
videoid_pkinteger(ID of the VideoID to refuse)required

ID of the VideoID to refuse

Bodyapplication/json
tokenstringrequired

The token containing RAO's credentials.

⚠ Not required when RAO's credentials (username, password, pin) are included as fields in this call.

usernamestringrequired

⚠ Not required when included in token (Create Token endpoint).

passwordstringrequired

⚠ Not required when included in token (Create Token endpoint).

pinstringrequired

⚠ Not required when included in token (Create Token endpoint).

raostring

⚠ Not required when included in token (Create Token endpoint).

reasonstringrequired

Reason that caused Video ID refusal

curl -i -X POST \
  'https://optimizer-developers.uanataca.com/oneshot/api/v1/api/v1/videoid/{videoid_pk}/refuse' \
  -H 'Content-Type: application/json' \
  -d '{
    "token": "string",
    "username": "string",
    "password": "string",
    "pin": "string",
    "rao": "string",
    "reason": "string"
  }'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Call Upload Videoid Evidences

Request

Upload evidences for a VideoID

Path
videoid_pkinteger(ID of the VideoID to which upload evidences)required

ID of the VideoID to which upload evidences

Bodyapplication/json
acceptanceobject

A set of acceptance parameters.

⚠ Customizable object for external authentication.

videoid_dataobject

Data to upload for Video ID.

⚠ Customizable object for external authentication.

curl -i -X POST \
  'https://optimizer-developers.uanataca.com/oneshot/api/v1/api/v1/videoid/{videoid_pk}/evidences' \
  -H 'Content-Type: application/json' \
  -d '{
    "acceptance": {
      "description": "string",
      "url-doc-privacypolicy": "string",
      "ip": "string",
      "url-web-videoid": "string",
      "user-agent": "string",
      "date": "string",
      "url-doc-termsconditions": "string"
    },
    "videoid_data": {
      "images": {
        "document_front": "string",
        "document_rear": "string",
        "document_photo": "string",
        "document_owner": "string"
      },
      "ocr_data": {
        "given_name": "string",
        "surname_1": "string",
        "surname_2": "string",
        "mobile_phone_number": "string",
        "email": "string",
        "serial_number": "string",
        "id_document_type": "IDC",
        "id_document_country": "string"
      },
      "security_checks": {
        "otp_validation": true,
        "documents_match": true,
        "data_integrity": true,
        "document_notcopy": true,
        "document_notexpired": true,
        "document_notunderage": true,
        "liveliness": true
      },
      "similarity_level": 0
    }
  }'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
{
  "status": "success",
  "message": "VideoID evidences uploaded"
}

Call Upload Videoid Video

Request

Upload video for a VideoID

Path
videoid_pkinteger(ID of the VideoID to which upload a video)required

ID of the VideoID to which upload a video

Bodymultipart/form-data
videostringrequired

The video to be uploaded

curl -i -X POST \
  'https://optimizer-developers.uanataca.com/oneshot/api/v1/api/v1/videoid/{videoid_pk}/video' \
  -H 'Content-Type: multipart/form-data' \
  -F video=string

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
{
  "status": "success",
  "message": "VideoID video uploaded"
}

Call Download Videoid Video

Request

Download VideoID video

Path
videoid_pkinteger(ID of the VideoID of the video to download)required

ID of the VideoID of the video to download

curl -i -X GET \
  'https://optimizer-developers.uanataca.com/oneshot/api/v1/api/v1/videoid/{videoid_pk}/video'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null