Get video 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:

Event	Description
`video_identity_verification.done`	Triggered when a video identity verification is complete

Example Webhook Payload for an approved video identity verification:

{
  "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": "approved",
      "status_codes": [ ]
    }
  }
}

The response_codes array provides specific error codes in the case a verification is declined, and can be used for troubleshooting.

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

Retrieve detailed video 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",
    "face_image_url": "https://storage-b.ubble.ai/11-production-ubble-ai/CKQNCMWHRPGT/idv_01jezpmz01mvn7r1n9eg596v5k/9a873da8-2395-4b05-b9a6-56644dfe2e06/9dc6948e-23b8-4405-81f2-28dccc0d9a71/face_asset_generation_0_rtc_face_0_rtc_face/face_crop_41.png?response-content-type=image%2Fpng&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=h6aivdggwQIvVyGWnAEw%2F20241216%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20241216T100820Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=xxx",
    "personal_data_anonymized": false
}

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 image of the document.
Verified: The names that were retained to perform the consistency check with the data you've declared.
Face image URL: You can also collect the image of the holder's face if you have requested it via the face-recognition parameter when initiating the video identity verification.

After 90 days, identity verification records are anonymized, meaning all personal or sensitive data associated with the verification request is permanently deleted.

If you attempt to retrieve any verification details beyond this retention period, fields containing sensitive data will return null, and the personal_data_expired parameter will be set to true:

{
    "id": "a08d2986-2b7f-439c-9f10-d8d65b06bb9d",
    "status": "declined",
    "status_codes": [ 62102 ],
    "declared": {
    	 "full_name": null
    },
    "extracted_from_document": {
    	 "full_name": null,
    	 "birth_at": null,
    	 "document_type": null,
    	 "document_issuing_country": null,
    	 "front_image_url": null
    },
    "verified": {
    	 "full_name": null
    },
    "verification_url": null,
    "face_image_url": null,
    "personal_data_anonymized": true
}

Please note that extracted images of the identity document and the holder’s face are only accessible for 10 minutes.

List all video identity verification requests

To retrieve a list of all verification requests, you can call the following endpoint. You can filter by status or paginate the results based on your needs:

GET /video_identity_verifications

{
  "meta": {
    "next_cursor": "string"
  },
  "data": [
    {
      "id": "89120884-d29a-4b1a-ac7b-a9e73a872795",
      "status": "approved",
      "status_codes": [],
      "created_at": "2025-01-21T15:59:19+00:00",
      "updated_at": "2025-01-21T15:59:21+00:00"
    }
  ]
}