# ID Document Verification webhooks

The [ID Document Verification](https://www.checkout.com/docs/business-operations/manage-identities/verify-id-documents.md) solution returns webhooks for the following types of event:

Successful verification:

1. `id_document_verification_created` – Occurs when you successfully create the verification
2. `id_document_verification_started` – Occurs when Checkout.com has confirmed image quality and starts checking authenticity
3. `id_document_verification_checks_completed` – Occurs when Checkout.com has successfully processed the verification
4. `id_document_verification_report_created` – Occurs when the verification report is available

Unsuccessful verification:

- `id_document_verification_closed` - Occurs when you forcibly close the verification
- `id_document_verification_checks_inconclusive` – Occurs when the applicant did not provide the images required to process the verification

After the verification:

- `id_document_verification_anonymized` – Occurs when the personal data is removed from a verification
- `id_document_verification_audit_completed` – Occurs when the verification is audited and the status has likely been updated

---

## Example webhooks

### Successful verification

**Created**

```json
{
  "id": "evt_lecalzfkynuengzghfkpta7hya",
  "type": "id_document_verification_created",
  "version": "1.2.0",
  "created_on": "2025-09-11T13:47:48.977127Z",
  "data": {
    "applicant_id": "aplt_01k4wge46qg8f3ax6gtbcb3kn3",
    "external_applicant_id": "eaplt_10000000000000000000000000",
    "status": "created",
    "id_document_verification_id": "iddv_01k4wggjsjsgq9exgfmq5qqd1z",
    "response_codes": [],
    "user_journey_id": "usj_01jrcvqv7w0ex6mrqcjwdpzn31"
  },
  "_links": {
    "self": {
      "href": "https://flow.cko-qa.ckotech.co/workflows/events/evt_lecalzfkynuengzghfkpta7hya"
    },
    "subject": {
      "href": "https://flow.cko-qa.ckotech.co/workflows/events/subject/iddv_01k4wggjsjsgq9exgfmq5qqd1z"
    }
  }
}
```

**Started**

```json
{
  "id": "evt_zew2glhpn5be7bhq636azhmtde",
  "type": "id_document_verification_started",
  "version": "1.2.0",
  "created_on": "2025-09-11T13:50:49.861077Z",
  "data": {
    "applicant_id": "aplt_01k4wge46qg8f3ax6gtbcb3kn3",
    "external_applicant_id": "eaplt_10000000000000000000000000",
    "status": "checks_in_progress",
    "id_document_verification_id": "iddv_01k4wggjsjsgq9exgfmq5qqd1z",
    "response_codes": [],
    "user_journey_id": "usj_01jrcvqv7w0ex6mrqcjwdpzn31"
  },
  "_links": {
    "self": {
      "href": "https://flow.cko-qa.ckotech.co/workflows/events/evt_zew2glhpn5be7bhq636azhmtde"
    },
    "subject": {
      "href": "https://flow.cko-qa.ckotech.co/workflows/events/subject/iddv_01k4wggjsjsgq9exgfmq5qqd1z"
    }
  }
}
```

**Checks completed**

```json
{
  "id": "evt_frkcdamnxvhuvgm6k562wdpla4",
  "type": "id_document_verification_checks_completed",
  "version": "1.2.0",
  "created_on": "2025-09-11T13:51:04.744393Z",
  "data": {
    "applicant_id": "aplt_01k4wge46qg8f3ax6gtbcb3kn3",
    "external_applicant_id": "eaplt_10000000000000000000000000",
    "status": "approved",
    "id_document_verification_id": "iddv_01k4wggjsjsgq9exgfmq5qqd1z",
    "response_codes": [
      {
        "code": 10000,
        "summary": "approved"
      }
    ],
    "user_journey_id": "usj_01jrcvqv7w0ex6mrqcjwdpzn31"
  },
  "_links": {
    "self": {
      "href": "https://flow.cko-qa.ckotech.co/workflows/events/evt_frkcdamnxvhuvgm6k562wdpla4"
    },
    "subject": {
      "href": "https://flow.cko-qa.ckotech.co/workflows/events/subject/iddv_01k4wggjsjsgq9exgfmq5qqd1z"
    }
  }
}
```

**Report created**

```json
{
  "id": "evt_rpbk7mcr7weufanr27xgjmye4q",
  "type": "id_document_verification_report_created",
  "version": "1.2.0",
  "created_on": "2025-09-11T13:51:07.448958Z",
  "data": {
    "applicant_id": "aplt_01k4wge46qg8f3ax6gtbcb3kn3",
    "external_applicant_id": "eaplt_10000000000000000000000000",
    "status": "approved",
    "id_document_verification_id": "iddv_01k4wggjsjsgq9exgfmq5qqd1z",
    "response_codes": [
      {
        "code": 10000,
        "summary": "approved"
      }
    ],
    "user_journey_id": "usj_01jrcvqv7w0ex6mrqcjwdpzn31"
  },
  "_links": {
    "self": {
      "href": "https://flow.cko-qa.ckotech.co/workflows/events/evt_rpbk7mcr7weufanr27xgjmye4q"
    },
    "subject": {
      "href": "https://flow.cko-qa.ckotech.co/workflows/events/subject/iddv_01k4wggjsjsgq9exgfmq5qqd1z"
    }
  }
}
```

### Unsuccessful verification

**Closed**

```json
{
  "id": "evt_mmajxqu4hr3ulfy5wu4fdtrphe",
  "type": "id_document_verification_closed",
  "version": "1.2.0",
  "created_on": "2025-09-11T14:12:37.377678Z",
  "data": {
    "applicant_id": "aplt_01k4wge46qg8f3ax6gtbcb3kn3",
    "external_applicant_id": "eaplt_10000000000000000000000000",
    "status": "inconclusive",
    "id_document_verification_id": "iddv_01k4whw7x0m7zrprdbdy490tet",
    "response_codes": [
      {
        "code": 61301,
        "summary": "document_video_blurry"
      }
    ],
    "user_journey_id": "usj_01jrcvqv7w0ex6mrqcjwdpzn31"
  },
  "_links": {
    "self": {
      "href": "https://flow.cko-qa.ckotech.co/workflows/events/evt_mmajxqu4hr3ulfy5wu4fdtrphe"
    },
    "subject": {
      "href": "https://flow.cko-qa.ckotech.co/workflows/events/subject/iddv_01k4whw7x0m7zrprdbdy490tet"
    }
  }
}
```

**Checks inconclusive**

```json
{
  "id": "evt_y2zvzhfx7s6excflwez7g7ga3i",
  "type": "id_document_verification_checks_inconclusive",
  "version": "1.2.0",
  "created_on": "2025-09-12T08:31:33.50375Z",
  "data": {
    "applicant_id": "aplt_01k4yfngkw39cf5ztmmgn911wz",
    "external_applicant_id": "eaplt_10000000000000000000000000",
    "status": "retry_required",
    "id_document_verification_id": "iddv_01k4ygstgqxypp7gb2h3jpffcx",
    "response_codes": [
      {
        "code": 61301,
        "summary": "document_video_blurry"
      }
    ],
    "user_journey_id": "usj_01jrcvqv7w0ex6mrqcjwdpzn31"
  },
  "_links": {
    "self": {
      "href": "https://flow.cko-qa.ckotech.co/workflows/events/evt_y2zvzhfx7s6excflwez7g7ga3i"
    },
    "subject": {
      "href": "https://flow.cko-qa.ckotech.co/workflows/events/subject/iddv_01k4ygstgqxypp7gb2h3jpffcx"
    }
  }
}
```

### After the verification

**Anonymized**

```json
{
  "id":"evt_t555mt5y33vutlwblmqibdkg2e",
  "type":"id_document_verification_anonymized",
  "version":"1.2.0",
  "created_on":"2025-09-19T10:15:26.993307Z",
  "data":{
    "applicant_id":"aplt_01k4yfngkw39cf5ztmmgn911wz",
    "external_applicant_id":"eaplt_10000000000000000000000000",
    "status":"inconclusive",
    "id_document_verification_id":"iddv_01k5gqgnjcye859kkqst0484xr",
    "response_codes":[
      {
        "code":64001,
        "summary":"forcibly_closed"
      }
    ],
    "user_journey_id":"usj_01jrcvqv7w0ex6mrqcjwdpzn31"
  },
  "_links":{
    "self":{
      "href":"https://flow.cko-qa.ckotech.co/workflows/events/evt_t555mt5y33vutlwblmqibdkg2e"
    },
    "subject":{
      "href":"https://flow.cko-qa.ckotech.co/workflows/events/subject/iddv_01k5gqgnjcye859kkqst0484xr"
    }
  }
}
```

**Audit completed**

```json
{
  "id":"evt_t555mt5y33vutlwblmqibdkg2e",
  "type":"id_document_verification_audit_completed",
  "version":"1.2.0",
  "created_on":"2025-09-19T10:15:26.993307Z",
  "data":{
    "applicant_id":"aplt_01k4yfngkw39cf5ztmmgn911wz",
    "external_applicant_id":"eaplt_10000000000000000000000000",
    "status":"approved",
    "id_document_verification_id":"iddv_01k5gqgnjcye859kkqst0484xr",
    "response_codes":[
      {
        "code":10000,
        "summary":"approved"
      }
    ],
    "user_journey_id":"usj_01jrcvqv7w0ex6mrqcjwdpzn31"
  },
  "_links":{
    "self":{
      "href":"https://flow.cko-qa.ckotech.co/workflows/events/evt_t555mt5y33vutlwblmqibdkg2e"
    },
    "subject":{
      "href":"https://flow.cko-qa.ckotech.co/workflows/events/subject/iddv_01k5gqgnjcye859kkqst0484xr"
    }
  }
}
```

---

## Webhook fields

| Field name | Description |
| --- | --- |
| `id`<br>`string` | The event's unique identifier, prefixed with `evt_`. |
| `type`<br>`string` | The event type. |
| `version`<br>`string` | The webhook version. |
| `created_on`<br>`date-time` | The date and time when the event occurred, in UTC. <br>Standard – ISO 8601 code <br>Format – `yyyy-mm-ddThh:mm:ss.sss` |
| `data`<br>`object` | The details of the webhook message. |
| `data.`<br>`applicant_id`<br>`string` | The applicant's unique identifier, prefixed with `aplt_`. |
| `data.`<br>`external_applicant_id`<br>`string` | Your unique identifier for the applicant, provided in the [Create an applicant request](https://www.checkout.com/docs/business-operations/manage-identities/manage-applicants.md#Create_an_applicant).<br>This is prefixed with `eaplt_`. |
| `data.`<br>`status`<br>`string` | The [ID document verification status](https://www.checkout.com/docs/developer-resources/codes/identities-codes.md#Check_statuses). |
| `data.`<br>`id_document_verification_id`<br>`string` | The ID document verification's unique identifier, prefixed with `iddv_`. |
| `data.`<br>`response_codes`<br>`object` | The details of the response code that provides more information about the status.<br><br>This is returned for the following events:<br><br>- `id_document_verification_anonymized`<br>- `id_document_verification_audit_completed`<br>- `id_document_verification_checks_completed`<br>- `id_document_verification_checks_inconclusive`<br>- `id_document_verification_closed`<br>- `id_document_verification_report_created` |
| `data.`<br>`response_codes.`<br>`code`<br>`number` | The [response code](https://www.checkout.com/docs/developer-resources/codes/identities-codes.md#Response_codes). |
| `data.`<br>`response_codes.`<br>`summary`<br>`string` | The summary that explains the response code. |
| `data.`<br>`user_journey_id`<br>`string` | Your ID Document Verification [configuration ID](https://www.checkout.com/docs/business-operations/manage-identities/verify-id-documents.md#Configuration), prefixed with `usj_`. |
| `_links.self.href`<br>`string` | The URL to the event. |
| `subject..href`<br>`string` | The URL to the ID Document Verification resource. |