Identity verification opened

Last updated: January 22, 2025

This Identity Verification event occurs when you create an attempt and the verification_url is available.


1{
2  "id": "evt_p62rw5x25mhebf6le52y4xndgu",
3  "type": "identity_verification_opened",
4  "version": "1.2.0",
5  "created_on": "2024-12-05T17:54:27.304558Z",
6  "data": {
7    "applicant_id": "aplt_01jebzam5y1x8jthps5pq28r27",
8    "external_applicant_id": "eaplt_10000000000000000000000000",
9    "status": "pending",
10    "identity_verification_id": "idv_01jebzasy9p8x0n71vgkdq9pty",
11    "response_codes": [],
12    "user_journey_id": "usj_01heqt35wmjrf3wjd7w1wz33p2"
13  },
14  "_links": {
15    "self": {
16      "href": "https://api.checkout.com/workflows/events/evt_p62rw5x25mhebf6le52y4xndgu"
17    }
18  }
19}

Field name	Description
`id` string	The unique identifier for the event.
`type` string	The event type.
`version` string	The version of the Identity Verification solution used.
`created_on` datetime	The date and time when the event was triggered, in UTC. Format – ISO 8601 code Example – `yyyy-mm-ddThh:mm:ss.ss`
`data` object	The webhook message.
`data.` `applicant_id` string	The unique identifier for the user.
`data.` `external_applicant_id` string	Your unique identifier for the user.
`data.` `status` string	The verification status.
`data.` `identity_verification_id` string	The unique identifier for the identity verification.
`data.` `response_codes` object	Contains information about the response code and summary.
`data.` `response_codes.code` integer	The response code that provides more information about the verification status.
`data.` `response_codes.summary` string	The description of the response code.
`data.` `user_journey_id` string	The unique identifier for the user journey configuration.
`_links.self.href` string	The URL to the event.

Identity verification opened

Example webhook

Webhook fields