Get identity verification results via Webhooks

Webhooks provide an efficient way to get notified when an identity 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 a Rejected Identity:

{
  "event_id": "d09f0367-d80a-309c-a2ed-7083991fc564",
  "event_name": "video_identity_verification.done",
  "event_time": "1348177752",
  "subscription_id": "c08h0287-c70a-213a-f2ed-9627309gb764",
  "subscription_description": "A great webhook",
  "sandbox": false,
  "data": {
    "video_identity_verification": {	 
      "id": "a08d2986-2b7f-439c-9f10-d8d65b06bb9d",
      "status": "declined",
      "status_codes": [ 61310, 62102 ]
    }
  }
}

In this example, the status field indicates that the identity verification was “declined.” The response_codes array provides specific error codes related to the rejection, which can be used for troubleshooting.

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

Retrieve detailed identity verification results

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

GET /video_identity_verifications/{id}

{
    "id": "a08d2986-2b7f-439c-9f10-d8d65b06bb9d",
    "status": "declined",
    "status_codes": [ 62102 ],
    "declared": {
    	 "full_name": "John Doe"
    },
    "extracted_from_document": {
    	 "full_name": "John Jane Doe",
    	 "birth_at": "1990-08-13T00:00:00+00:00",
    	 "document_type": "ID",
    	 "document_issuing_country": "FRA",
    	 "front_image_url": "https://storage-b.ubble.ai/25-production-ubble-ai/KOWMPWMDYOLY/idv_01j82nca8yh0jrrrwkv9qgnw3g/2f3e833c-6cf8-4c39-9004-cfb0e048ef63/1efc011f-c2e5-422a-9fae-0263decfbb5e/document_0_side_front_doc_asset_generation_0_auto_0_rtc_dolar/tight_crop_48.png?response-content-type=image%2Fpng&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=h6aivdggwQIvVyGWnAEw%2F20241018%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20241018T145934Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=1af262bd8324b3d2d635503d152692b3621ab3d2794217a803fe6ff4de436320"
    },
    "verified": {
    	 "full_name": "John Doe"
    },
    "verification_url": "https://id.ubble.ai/2f3e833c-6cf8-4c39-9004-cfb0e048ef63"
}

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 additional information about the verification:

• Declared: The first and last names you provided when initiating the identity verification request.
• Extracted from document: The data extracted from the ID document, such as the full name, the issuing country of the document, or the images of the document.
• Verified: The names that were retained to perform the consistency check with the data you've declared

Data management

After 90 days, the identity verifications are anonymized, which means all personal or sensitive data are deleted.