Skip to main content
WEBHOOK
kyc-connector.veriff.ingestion.created
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "kyc-connector.veriff.ingestion.created",
  "createdAt": "2021-01-01T00:00:00.000Z",
  "data": {
    "ingestion": {
      "id": "019b2184-1ca9-7dd6-b7a5-ec242def68b0",
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "status": "queued",
      "processes": [
        "profile",
        "address",
        "identity",
        "proof-of-address"
      ],
      "provider": "veriff",
      "parameters": {
        "sessions": [
          {
            "processes": [
              "profile",
              "identity"
            ],
            "sessionId": "550e8400-e29b-41d4-a716-446655440000",
            "integrationName": "integration-abc123"
          },
          {
            "processes": [
              "address",
              "proof-of-address"
            ],
            "sessionId": "661f9511-f30c-52e5-b827-557766551111",
            "integrationName": "integration-def456"
          }
        ]
      },
      "createdAt": "2026-01-15T14:23:01.819Z",
      "updatedAt": "2026-01-15T14:23:01.819Z"
    }
  }
}

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication

Headers

​
webhook-id
string
required

The unique identifier of the webhook.

​
webhook-timestamp
integer
required

The timestamp of the webhook, in seconds after the Unix epoch.

​
webhook-signature
string
required

The signature of the webhook.

Body

application/json

Veriff ingestion created event.

The webhook event information.

​
id
string<uuid>
required

The id of the event.

​
type
string
required

The type of event.

​
createdAt
string<date-time>
required

The date and time when the event was created.

​
data
object
required

The event payload.

Response

200

Return a 200 status to indicate that the data was received successfully.