YOyousign
Signer

Pre-verify an identity document

Verifying an identity document for a Signer to know if their document is valid before enabling them to sign using Advanced Electronic Signature.

post/signature_requests/{signatureRequestId}/signers/{signerId}/identity_verification

Request

  • Base URL
    https://api-sandbox.yousign.app/v3
  • Auth
    HTTP bearer

Path parameters

signatureRequestIdstring uuid required

The unique identifier for a resource.

Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c

Signature Request Id

signerIdstring uuid required

The unique identifier for a resource.

Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c

Signer Id

Request body multipart/form-data

type'id_card' | 'passport' | 'residence_permit' required

Type of document you are looking to verify. Only passports, id and resident permits are accepted.

rectostring binary required

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

versostring binary

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

Example request

{
  "type": "id_card"
}

Response

No Content

Changes

No recorded changes to this operation across all 2 revisions of this API.