Identity verification closed

Last updated: January 22, 2025

This Identity Verification event occurs when the user forcibly closes the flow.


1{
2  "id": "evt_wqhgmnsx734unhl67hcpnxeyiq",
3  "type": "identity_verification_closed",
4  "version": "1.2.0",
5  "created_on": "2024-12-05T18:04:00.334629Z",
6  "data": {
7    "applicant_id": "aplt_01jebzt00z21ac7v8mf2hvs0ec",
8    "external_applicant_id": "eaplt_61203A62103000000000000000",
9    "status": "retry_required",
10    "identity_verification_id": "idv_01jebzt41x6h42jnbg0913vv4k",
11    "response_codes": [
12      {
13        "code": 64001,
14        "summary": "forcibly_closed"
15      }
16    ],
17    "user_journey_id": "usj_01heqt35wmjrf3wjd7w1wz33p2"
18  },
19  "_links": {
20    "self": {
21      "href": "https://api.checkout.com/workflows/events/evt_wqhgmnsx734unhl67hcpnxeyiq"
22    }
23  }
24}

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 closed

Example webhook

Webhook fields