---
title: "Identity Verification Webhooks"
method: POST
path: "/idv/{verificationId}"
tags: ["Webhooks"]
---

# Identity Verification Webhooks

`POST /idv/{verificationId}`

## Request

- Base URL: `https://mysite.com/api/fourthline`
- URL: `https://mysite.com/api/fourthline/idv/{verificationId}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://example.com/token`

Webhook notifications for <a href="https://docs.fourthline.com/docs/idv-solutions">Identity Verification</a>. For setup and authentication, see <a href="https://docs.fourthline.com/docs/webhooks">Webhooks</a>. <br /><br />`flowVariant` is returned when the workflow offers both eID and verification with a physical ID document. When the workflow does not offer both, the property is absent. `eIDVerification` means the client completed eID. `DocumentVerification` means the client completed verification with a physical ID document. Confirm the value with <a href="https://docs.fourthline.com/reference/get-case-status">Get case status</a>.

## Path parameters

- `verificationId` string, required

## Headers

- `Authorization` string, required

## Request body

- object
  - `verificationId` string, required: Our unique identifier for the case. <br /><br />Format: uuid string <br /><br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br />Validations: uuid format, `verificationId` exists <br />Errors: Format is incorrect or doesn’t exist
  - `hash` string: The hash code of the [XML file](https://docs.fourthline.com/docs/reports#xml-file). <br /><br />Format: MD5 hash <br />Validation: MD5 hash <br />Errors: Invalid MD5 hash
  - `status` 'new' | 'pending' | 'inconsistent_data' | 'invalid_data' | 'completed', required: The [case status](https://docs.fourthline.com/docs/idv-statuses). <br />Validation: Valid enum value <br />Errors: Invalid enum value.
  - `processType` string, required: The type of workflow. <br />Expected value: Always `NaturalPersons` <br />Validation: Expected value <br />Errors: Must be set to `NaturalPersons`.
  - `flowVariant` 'eIDVerification' | 'DocumentVerification': Returned when the workflow offers both eID and verification with a physical ID document. When the workflow does not offer both, the property is absent. Confirm the value with Get case status. <br /><br />Enum: <br />• `eIDVerification`: the client completed eID <br />• `DocumentVerification`: the client completed verification with a physical ID document
  - `sla` Sla: Information about the SLA for case processing.
    - `kycReceived` string: The timestamp for when the case was created. <br /><br />Format: ISO 8601 UTC date and time <br /><br />Example: `2020-07-10 15:00:00.000` <br />Validation: Valid datetime <br />Errors: Invalid datetime
    - `slaStart` string: The timestamp for when case processing started. <br /><br />Format: ISO 8601 UTC date and time <br /><br />Example: `2020-07-10 15:00:00.000` <br />Validation: Valid datetime <br />Errors: Invalid datetime
    - `slaPause` string: The timestamp for when we paused case processing, e.g. because we sent the case back to you to request more information. <br /><br />Format: ISO 8601 UTC date and time <br /><br />Example: `2020-07-10 15:00:00.000` <br />Validation: Valid datetime <br />Errors: Invalid datetime
    - `slaEnd` string: The timestamp for when case processing was completed. <br /><br />Format: ISO 8601 UTC date and time <br /><br />Example: `2020-07-10 15:00:00.000` <br />Validation: Valid datetime <br />Errors: Invalid datetime
    - `withinSla` boolean: • `true`: The case was processed within the SLA. <br />• `false`: The case **wasn’t** processed within the SLA. <br />Validation: `true` or `false` value <br />Errors: Invalid boolean value.
    - `slaBucket` 'bucket1' | 'bucket2' | 'bucket3': The SLA category for the case, as defined in your configuration.
  - `messages` object: Information about the [case status](https://docs.fourthline.com/docs/idv-statuses).
    - `timestamp` string, required: The timestamp for this status change. <br /><br />Format: ISO 8601 UTC date and time <br /><br />Example: `2020-07-10 15:00:00.000` <br />Validation: Valid datetime <br />Errors: Invalid datetime
    - `statusCode` integer, required: The [status code](https://docs.fourthline.com/docs/idv-statuses#status-codes). <br />Validation: Integer between 0 and 6050 <br />Errors: Value must be an integer between 0 and 6050.
    - `description` string, required: The status code description.
  - `dataRectified` boolean, required: The marker for whether the notification was triggered by a post-completion QA data correction. This field is included in every webhook notification. <br /><br />• `true`: A Fourthline QA analyst has corrected case data after the verification was completed. <br />• `false`: Standard notification. No post-completion QA correction has been applied. <br /><br />This feature is only active if Fourthline has enabled QA corrections for your account. Contact your delivery manager for more information. <br />Validation: `true` or `false` value <br />Errors: Invalid boolean value.
  - `timestamp` string, required: The timestamp for this notification. <br /><br />Format: ISO 8601 UTC date and time <br /><br />Example: `2020-07-10 15:00:00.000` <br />Validation: Valid datetime <br />Errors: Invalid datetime

## Response `200`

Return HTTP 2xx to acknowledge receipt. See [Handle webhook deliveries](https://docs.fourthline.com/docs/webhooks#200-ok).

- object: A successful response is empty.

## Other responses

- `401`: Fourthline could not authenticate with your webhook endpoint. See [troubleshooting](https://docs.fourthline.com/docs/webhooks#401-unauthorized).
- `403`: Fourthline could not authenticate with your webhook endpoint. See [troubleshooting](https://docs.fourthline.com/docs/webhooks#403-forbidden).
- `404`: Fourthline can reach your server, but the webhook endpoint could not be found. See [troubleshooting](https://docs.fourthline.com/docs/webhooks#404-not-found).
- `500`: Your server received the request but could not process it successfully. See [troubleshooting](https://docs.fourthline.com/docs/webhooks#500-internal-server-error).

---

[API](https://skmtc.dev/fourthline/apis/webhooks.md) - [All operations](https://skmtc.dev/fourthline/apis/webhooks/llms.txt) - [OpenAPI document](https://skmtc.dev/fourthline/apis/webhooks/revisions/4df6bbbf587c?raw)