Request a video identity verification

On this page, you will learn how to initiate a new video identity verification using the API.

To initiate the verification process, you need to send the person’s full name and a redirection URL, using the following endpoint:

POST /verifications/identity_videos

{
    "first_name": "John",
    "last_name": "Doe",
    "redirection_url": "https://redirectionurl.com",
    "face_recognition": false,
    "workspace_id": "090b4f7e-25e8-423d-9387-741f6188ba7a"
}

{
    "id": "89120884-d29a-4b1a-ac7b-a9e73a872795",
    "workspace_id": "090b4f7e-25e8-423d-9387-741f6188ba7a",
    "created_at": "2025-03-24T13:32:26+00:00",
    "updated_at": "2025-03-24T13:32:26+00:00",
    "status": "pending",
    "status_codes": [],
    "face_recognition": false,
    "data_anonymized": false,
    "verification_url": "https:\/\/id.ubble.ai\/add29f2e-9671-40b4-b7b3-77d263f62897",
    "data": {
        "extracted_from_document": {
            "full_name": null,
            "born_on": null,
            "type": null,
            "issuing_country_code": null
        },
        "evidence": {
            "document_front_image_url": null,
            "face_image_url": null
        }
    }
}

Query Param	Type	Description
first_name	string	[required] The first name of the person whose identity needs to be verified. Note: The first name provided must match exactly as it appears on the ID document, as a consistency check will be performed. If multiple given names are listed on the document, you must provide only one of them.
last_name	string	[required] The last name of the person whose identity needs to be verified. Note: The last name provided must match exactly as it appears on the ID document, as a consistency check will be performed. If both a birth name and a usage name are listed on the document, you must provide one of them, but not both.
redirection_url	string	[required] The URL to redirect the person back to your application or website after the identity verification flow is complete.
face_recognition	boolean	[optional] Enhances verification by incorporating a facial scan to confirm that the user’s face matches the photograph on their ID document. This parameter is disabled by default.
workspace_id	string	[optional] Scopes the verification to a specific workspace. Defaults to the main workspace if not specified.

In the response, you'll find these important following values:

id: This value is required to retrieve the verification results.
verification_url: Share this URL with the person whose identity needs to be verified. They will use it to follow a process on mobile to upload the front and back of their ID document. Note that the verification link expires after 15 minutes.

Updated about 1 hour ago