Get identity document verification results via Webhooks

Webhooks provide an efficient way to get notified when an ID document verification has been completed, and to retrieve the related verification results.
For more details on setting up and managing Webhooks, please refer to this dedicated section.

To receive those notifications, subscribe to the following event:

Example Webhook Payload for an approved identity document verification:

{
  "event_id": "d09f0367-d80a-309c-a2ed-7083991fc564",
  "event_name": "id_document_verification.done",
  "event_time": "1348177752",
  "subscription_id": "d09f0367-d80a-309c-a2ed-7083991fc564",
  "subscription_description": "A great webhook",
  "sandbox": false,
  "data": {
    "id_document_verification": {	 
      "id": "a08d2986-2b7f-439c-9f10-d8d65b06bb9d",
      "status": "approved",
      "status_codes": [ ]
    }
}

For more information on the statuses and error codes, refer to this section.

Retrieve detailed identity document verification results

You can also obtain detailed verification results by calling a dedicated endpoint, with the id returned when requesting an identity document verification:

GET /id_document_verifications/{id}

{
    "id": "a08d2986-2b7f-439c-9f10-d8d65b06bb9d",
    "status": "approved",
    "status_codes": [],
    "extracted_from_document": {
    	 "first_name": "John",
    	 "last_name": "Doe",
    	 "birth_name": "Doe",
    	 "birth_at": "1990-08-13",
    	 "birth_place": "Paris",
    	 "gender": "M",
    	 "postal_address": "18 rue de Londres\nParis\nFRANCE",
    	 "document_type": "ID",
    	 "document_issuing_country": "FR",
    	 "document_issuing_date": "2010-08-10",
    	 "document_expiration_date": "2020-08-10",
    	 "document_number": "X4RBBPFW4",
    	 "mrz": {
          "line1": "IDFRASIAGRA<<<<<<<<<<<<<<<<<<<133039",
          "line2": "1002133008071JOHN<<<<<<LIAM8110228M4"
      }
    }
}

Similar to the webhook, you will receive the verification status and any associated error codes if the verification was declined. For more information on the statuses and error codes, refer to this section.

This endpoint returns also the data extracted from the ID document, such as the holder's name, the birth date or the document issuing country.

Not all information listed in the example above is always available in the ID document. When a piece of information is missing, the endpoint will return null for that field.

Data management

The data stored during ID document verifications is retained for 7 days, after which it is deleted.