Qodex.ai

/check-document/identities

POST https://staging-api.yousign.com/check-document/identities

Yousign performs an automatic verification of the identity document with the following checks:

  • Consistency check of the MRZ. This is the Machine Readable Zone found at the bottom of the identification documents.

  • With a character recognition system, we check that the data read on the front of the part is the same as the data contained in the MRZ.

  • We check that all the visual security elements are well positioned and appear coherent (photo, signature,...).

  • We check that the part is valid. Note: For IDs issued between 1 January 2004 and 31 December 2014, the additional 5-year period granted by law is taken into account in calculating the expiry date (from the date of issue indicated on the front of the card).

  • Consistency check between the surname and first name of the member present on the identity document.

  • Consistency check between the date of birth of the member present on the identity document and that entered.

It's important to transfer a colour image for the front of the ID (contains the MRZ).

Request Body

{"file"=>"JVBERi0xLjYKJeTw [...] +PgpzdGFydHhyZWYKMTMxCiUlRU9GCg==", "firstNames"=>["First name 1", "First name 2", "First name 3"], "birthName"=>"Last name", "birthDate"=>"YYYY-MM-DD"}

HEADERS

KeyDatatypeRequiredDescription
Content-TypestringThis header specifies the format of the exchanges in JSON.
AuthorizationstringThis value is a secret and needs to be replaced by your API Key (Bearer).

RESPONSES

status: Created

{"id":"/check-document/identities/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","createdAt":"2019-06-25T14:33:28+02:00","updatedAt":"2019-06-25T14:33:28+02:00","workspace":"/workspaces/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","creator":null,"firstNames":["First name 1","First name 2","First name 3"],"birthName":"Last name","birthDate":"YYYY-MM-DDT00:00:00+02:00","documentType":"ID_CARD","extractedFirstNames":["FIRST NAME 1","FIRST NAME 2"],"extractedBirthName":"LAST NAME","extractedBirthDate":"YYYY-MM-DDT00:00:00+02:00","extractedGender":"M","extractedIssuanceDate":"2009-09-01T00:00:00+02:00","extractedExpirationDate":"2024-09-01T00:00:00+02:00","extractedMrz":["IDFRAXXXXXXX\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003cXXXXXX","XXXXXXXXXXXXXYYYYY\u003c\u003cZZZZ\u003cXXXXXXXXX"],"firstNameValid":true,"birthNameValid":true,"mrzValid":true,"expired":false,"company":"/companies/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","valid":true}