Sign in

v1

latestOpenAPI 3.0.0proprietary2026-07-261695971.5 MB
Identity Video Verification

Initiate a new Identity Video Verification

Request verification of a person's identity by recording their documents and/or themselves.

post/verifications/identity_videos

Request body

first_namestring required
last_namestring required
redirection_urlstring uri required

The URL to redirect the person back to your application or website after the identity verification flow is complete.

face_recognitionboolean

Enable face recognition step in the identity verification flow.

pvidboolean

Enable PVID mode in the identity verification flow.

workspace_idstring uuid nullable

Scopes the verification to a specific workspace. Defaults to the default workspace if not specified.

workflow_session_idstring uuid nullable

Unique identifier of a Workflow Session. When provided, an Action is created in the Workflow Session, and this resource is associated with that Action.

previous_attempt_idstring uuid nullable

ID of the previous attempt within the same workflow_session_id. Allows continuity between multiple attempts of the same Action. Null if this is the first attempt.

min_ageinteger nullable

Minimum age required for the document holder.

max_ageinteger nullable

Maximum age allowed for the document holder.

prohibited_countriesstring[] nullable

List of prohibited issuing countries (ISO 3166-1 alpha-2).

pre_selected_residence_country_codestring ISO 3166-1 alpha-2 nullable

Pre-fill the residence country in the verification flow (ISO 3166-1 alpha-2, uppercase).

pre_selected_document_issuing_country_codestring ISO 3166-1 alpha-2 nullable

Pre-fill the document issuing country in the verification flow (ISO 3166-1 alpha-2, uppercase).

pre_selected_document_type'id_card' | 'passport' | 'residence_permit' | 'driver_license' | 'travel_document' nullable

Pre-fill the document type in the verification flow.

pre_selected_localestring ISO 639-1 nullable

Pre-fill the UI language of the verification flow (ISO 639-1, lowercase 2-letter code).

Example request

{
  "redirection_url": "https://example.com/",
  "workspace_id": "9412b83b-b4b9-4a94-97b5-2b43dfa4cde3",
  "workflow_session_id": "0ef334d2-7f36-4643-8a2a-4283b4a3e4a4",
  "previous_attempt_id": "9412b83b-b4b9-4a94-97b5-2b43dfa4cde4",
  "min_age": 18,
  "max_age": 65,
  "prohibited_countries": [
    "RU",
    "KP"
  ],
  "pre_selected_residence_country_code": "FR",
  "pre_selected_document_issuing_country_code": "FR",
  "pre_selected_document_type": "id_card",
  "pre_selected_locale": "fr"
}

Response

Created

idstring uuid required

The unique identifier for a resource.

workspace_idstring uuid required

The Workspace ID in which the verification has been created.

created_atstring date-time required

Creation date of the Identity Video Verification.

updated_atstring date-time required

Update date of the Identity Video Verification.

status'pending' | 'verified' | 'failed' | 'inconclusive' required

Status of the Identity Video Verification

status_codesstring[] required

List of status codes. Indicates the cause when the status is failed or inconclusive.

data_anonymizedboolean required

Indicates if the personal data extracted has been anonymized. If set to true, the personal data has been anonymized and most fields will be NULL.

face_recognitionboolean required

Indicates if face recognition was enabled during the verification process.

pvidboolean required

Indicates if PVID was enabled during the verification process.

workflow_session_idstring uuid nullable required

Unique identifier of a Workflow Session. When provided, an Action is created in the Workflow Session, and this resource is associated with that Action.

previous_attempt_idstring uuid nullable required

ID of the previous attempt within the same workflow_session_id. Allows continuity between multiple attempts of the same Action. Null if this is the first attempt.

verification_urlstring uri nullable required

The URL of the verification page that the user used to begin the verification process.

Example response

{
  "id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c",
  "workspace_id": "9412b83b-b4b9-4a94-97b5-2b43dfa4cde3",
  "created_at": "2024-01-18T22:59:00Z",
  "updated_at": "2024-01-18T22:59:00Z",
  "status": "verified",
  "status_codes": [
    "IDVV_1112"
  ],
  "workflow_session_id": "0ef334d2-7f36-4643-8a2a-4283b4a3e4a4",
  "previous_attempt_id": "9412b83b-b4b9-4a94-97b5-2b43dfa4cde4",
  "verification_url": "https://id.ubble.ai/2f3e833c-6cf8-4c39-9004-cfb0e048ef63",
  "data": {
    "extracted_from_document": {
      "full_name": "David Vincent",
      "born_on": "2024-01-18",
      "issuing_country_code": "US",
      "national_identification_number": "MLLSNT82P65Z404U"
    },
    "evidence": {
      "document_front_image_url": "https://storage-b.env.ubble.ai/ubble-ai/88bf48f0-ce4a-449c-9af1-f138a7e09392/ae1f813a-02cf-4ffc-bf71-d823ed74dc8d/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/aaa.png?X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=xxx",
      "document_back_image_url": "https://storage-b.env.ubble.ai/ubble-ai/88bf48f0-ce4a-449c-9af1-f138a7e09392/ae1f813a-02cf-4ffc-bf71-d823ed74dc8d/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/bbb.png?X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=xxx",
      "face_image_url": "https://storage-b.ubble.ai/11-production-ubble-ai/CKQNCMWHRPGT/idv_01jezpmz01mvn7r1n9eg596v5k/9a873da8-2395-4b05-b9a6-56644dfe2e06/9dc6948e-23b8-4405-81f2-28dccc0d9a71/face_asset_generation_0_rtc_face_0_rtc_face/face_crop_41.png?response-content-type=image%2Fpng&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=h6aivdggwQIvVyGWnAEw%2F20241216%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20241216T100820Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=xxx"
    }
  }
}