API Reference
Status PageRoadmapTestimoniesShare feedback

Initiate a new Video Identity Verification

post
https://api-sandbox.yousign.app/v3/verifications/identity_videos

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

Body Params
string
required
length between 1 and 255

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.

string
required
length between 1 and 255

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.

uri
required
length between 1 and 2000

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

boolean
Defaults to false

Enable face recognition step in the identity verification flow.

boolean
Defaults to false

Enable PVID mode in the identity verification flow.

uuid | null

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

uuid | null

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

uuid | null

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.

Responses

Updated 9 days ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 9 days ago