Request a video identity verification

On this page, you will learn how to initiate a new 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 /video_identity_verifications

{
    "first_name": "John",
    "last_name": "Doe",
    "redirection_url": "https://redirectionurl.com"
}
{
	"id": "14bf533c-964f-4927-8267-b577d2776321",
	"verification_url": "https://id.ubble.ai/909dc556-5e8f-40b7-8504-a7fd05052d27"
}
Query ParamTypeDescription
first_namestringThe 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_namestringThe 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_urlstringThe URL to redirect the person back to your application or website after the identity verification flow is complete.
face_recognitionboolean[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.

In the response, you'll find the 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.