Skip to main content
WEBHOOK
kyc-connector.sumsub.ingestion.status-changed
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "kyc-connector.sumsub.ingestion.status-changed",
  "createdAt": "2021-01-01T00:00:00Z",
  "data": {
    "ingestion": {
      "id": "019b218f-f235-79d3-866c-f56215e515e2",
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "status": "finished",
      "processes": [
        "identity",
        "proof-of-address"
      ],
      "provider": "sumsub",
      "parameters": {
        "shareToken": "_act-sbx-jwt-eyJhbGciOiJub25lIn0.eyJqdGkiOiJ0ZXN0IiwidXJsIjoiaHR0cHM6Ly9leGFtcGxlLmNvbSJ9."
      },
      "result": {
        "identity": {
          "status": "completed",
          "data": {
            "document": {
              "type": "passport",
              "number": "7700225VH",
              "country": "GB",
              "expiresAt": "2026-03-13"
            },
            "person": {
              "givenName": "John",
              "familyName": "Doe",
              "birthdate": "1987-01-01",
              "gender": "male"
            },
            "verifiedAt": "2020-01-01T00:00:00Z"
          },
          "files": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "category": "document",
              "context": "photo-document-front",
              "contentType": "image/png",
              "size": 204800,
              "providerDetails": {
                "fileId": "732150141"
              }
            }
          ]
        },
        "proofOfAddress": {
          "status": "failed",
          "error": {
            "code": "provider_data_not_available",
            "message": "Profile data not available in Sumsub applicant info"
          }
        }
      },
      "startedAt": "2025-12-15T10:17:45.113Z",
      "finishedAt": "2025-12-15T10:18:33.241Z",
      "createdAt": "2025-12-15T10:17:44.911Z",
      "updatedAt": "2025-12-15T10:18:33.241Z"
    }
  }
}

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

Sumsub ingestion status changed 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.