API Reference
Status PageRoadmapTestimoniesShare feedback

Initiate a new Identity Document Verification

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

Verify a person's Identity Document by sending the file containing their Identity Document (identity card, passport, residence permit or driving license).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 255

Please provide the holder first name, exactly as it appears on the ID document. Please match it exactly, with the same characters, same case. One exception: if the document mentions an honorary title, please don't provide it as part of the name.

string
required
length between 1 and 255

Please provide the holder last name, exactly as it appears on the ID document birth name. Please match it exactly, with the same characters, same case. One exception: if the document mentions an honorary title, please don't provide it as part of the name.

string
enum

The document type to verify

Allowed:
file
required

The identity document file to verify. Accepted formats: PNG, JPEG, JPG, PDF. Max size: 10 MB. Max resolution: 20 mpx.

file

Additional document file, such as the back side of an identity card. Accepted formats: PNG, JPEG, JPG, PDF. Max size: 10 MB. Max resolution: 20 mpx.

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.

integer | null
≥ 1

Minimum age required for the document holder.

integer | null
≥ 1

Maximum age allowed for the document holder.

prohibited_countries
array of strings | null

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

prohibited_countries
Responses

Updated 2 days ago

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

Updated 2 days ago