User verification webhooks are used during verification of your applicants.

Webhook	Description
applicantReviewed	Verification is complete. Contains verification result.
applicantPending	An applicant has uploaded the required documents and their status changed to `Pending`.
applicantCreated	The applicant is created.
applicantOnHold	Further processing of the applicant profile is put on hold.
applicantPersonalInfoChanged	Applicant personal information has been changed.
applicantPrechecked	Primary data processing is complete.
applicantDeleted	Applicant has been permanently deleted.
applicantLevelChanged	Applicant level has been changed.
videoIdentStatusChanged	Status of the Video identification type has been changed.
applicantReset	Applicant has been reset — applicant status changed to `init` and all documents were set as inactive.
applicantActionPending	Applicant action status changed to `Pending`.
applicantActionReviewed	Applicant action verification has been completed.
applicantActionOnHold	Applicant action verification has been paused.
applicantWorkflowCompleted	Workflow has been completed for an applicant.

Payload attributes

The following is a collection of attributes present in webhooks.

Name	Type	Always present?	Description
`applicantId`	String	No	A unique applicant identifier.
`inspectionId`	String	No	A unique inspection identifier.
`correlationId`	String	No	A unique identifier of the event.
`levelName`	String	Yes	The verification level name.
`externalUserId`	String	No	A unique user identifier on your side.
`type`	String	No	The webhook type.
`sandboxMode`	Boolean	No	Set to `True` if the webhook was sent from Sandbox.
`reviewStatus`	String	No	The current applicant status.
`createdAtMs`	Date	No	Date and time when the webhook was created (format `yyyy-MM-dd HH:mm:ss.fff`, e.g. 2021-05-14 16:00:25.032) in UTC.
`applicantType`	String	Yes	The applicant type (`company`) or (`individual`).
`reviewResult`	Object	Yes	Field that contains extra information on applicant verification results.
`applicantMemberOf`	Array of objects	Yes	Contains the list of company `applicantIds` to which the current applicant belongs as a beneficiary.
`videoIdentReviewStatus`	String	Yes	Status of the VideoIdent call.
`applicantActionId`	String	Yes	A unique applicant action identifier.
`externalApplicantActionId`	String	Yes	A unique applicant action identifier on your side.
`clientId`	String	No	Your unique identifier as our client.

📘
Note
We do not send any personal data via webhooks. You can fetch all recognized data using this API method.

Payload examples

This section lists a collection of webhooks that you may receive during or after verification.

📘
Note
If you are not receiving webhooks, try to check your endpoints using SSL Labs or Docker.

applicantReviewed

{
  "applicantId": "5cb744200a975a67ed1798a4",
  "inspectionId": "5cb744200a975a67ed1798a5",
  "correlationId": "req-fa94263f-0b23-42d7-9393-ab10b28ef42d",
  "externalUserId": "externalUserId",
  "levelName": "basic-kyc-level",
  "type": "applicantReviewed",
  "reviewResult": {
    "moderationComment": "We could not verify your profile. Please contact support: [email protected]",
    "clientComment": " Suspected fraudulent account.",
    "reviewAnswer": "RED",
    "rejectLabels": ["UNSATISFACTORY_PHOTOS", "GRAPHIC_EDITOR", "FORGERY"],
    "reviewRejectType": "FINAL"
  },
  "reviewStatus": "completed",
  "createdAtMs": "2020-02-21 13:23:19.001"
}

{
  "applicantId": "5cb56e8e0a975a35f333cb83",
  "inspectionId": "5cb56e8e0a975a35f333cb84",
  "correlationId": "req-a260b669-4f14-4bb5-a4c5-ac0218acb9a4",
  "externalUserId": "externalUserId",
  "levelName": "basic-kyc-level",
  "type": "applicantReviewed",
  "reviewResult": {
    "reviewAnswer": "GREEN"
  },
  "reviewStatus": "completed",
  "createdAtMs": "2020-02-21 13:23:19.321"
}

applicantCreated

{
  "applicantId": "5c9e177b0a975a6eeccf5960",
  "inspectionId": "5c9e177b0a975a6eeccf5961",
  "correlationId": "req-63f92830-4d68-4eee-98d5-875d53a12258",
  "levelName": "basic-kyc-level",
  "externalUserId": "12672",
  "type": "applicantCreated",
  "sandboxMode": "false",
  "reviewStatus": "init",
  "createdAtMs": "2020-02-21 13:23:19.002",
  "clientId": "coolClientId"
}

applicantPending

{
  "applicantId": "5c7791f80a975a1df426b9e9",
  "inspectionId": "5c7791f80a975a1df426b9ea",
  "applicantType": "individual",
  "correlationId": "req-4af54c06-6a50-4cb9-a7dc-b94b2f5b07eb",
  "levelName": "liveness-level",
  "externalUserId": "12672",
  "type": "applicantPending",
  "sandboxMode": "false",
  "reviewStatus": "pending",
  "createdAtMs": "2020-02-21 13:23:19.002",
  "clientId": "coolClientId"
}

applicantOnHold

{
  "applicantId": "5c7791f80a975a1df426b9e9",
  "inspectionId": "5c7791f80a975a1df426b9ea",
  "applicantType": "individual",
  "correlationId": "req-4af54c06-6a50-4cb9-a7dc-b94b2f5b07eb",
  "levelName": "liveness-level",
  "externalUserId": "12672",
  "type": "applicantPending",
  "sandboxMode": "false",
  "reviewStatus": "pending",
  "createdAtMs": "2020-02-21 13:23:19.002",
  "clientId": "coolClientId"
}

applicantPersonalInfoChanged

{
  "applicantId": "5ede51230a975a19a19ba5c1",
  "inspectionId": "5ede51230a975a19a19ba5c2",
  "applicantType": "individual",
  "correlationId": "req-60103dee-79f1-43f4-bdcc-eb2554556afa",
  "levelName": "id+liveness",
  "externalUserId": "12672",
  "type": "applicantPersonalInfoChanged",
  "sandboxMode": "false",
  "reviewResult": {
    "reviewAnswer": "GREEN"
  },
  "reviewStatus": "completed",
  "createdAtMs": "2020-06-08 19:39:29.002",
  "clientId": "coolClientId"
}

applicantPrechecked

{
  "applicantId": "5d1f2914c2d75a1c14130bd2",
  "inspectionId": "5d1f2914c2d75a1c14130bd3",
  "applicantType" : "individual",
  "correlationId": "req-e9d77142-59e6-4713-9b07-9b342cc51dda",
  "levelName": "kyc",
  "externalUserId": "12672",
  "type": "applicantPrechecked",
  "sandboxMode": "false",
  "reviewStatus": "queued",
  "createdAtMs": "2020-02-21 13:23:19.002",
  "clientId": "SumsubClient"
}

applicantDeleted

{
  "applicantId": "5f194e74040c3f316bda271c",
  "inspectionId": "5f194e74040c3f316bda271d",
  "applicantType": "individual",
  "correlationId": "req-d34c974c-5935-41b8-a0a9-cedd2407eada",
  "levelName": "phone-level",
  "externalUserId": "12672",
  "type": "applicantDeleted",
  "sandboxMode": "false",
  "reviewStatus": "init",
  "createdAtMs": "2020-07-23 11:18:33.002",
  "clientId": "coolClientId"
}

applicantLevelChanged

{
  "applicantId": "5f194e74040c3f316bda271c",
  "inspectionId": "5f194e74040c3f316bda271d",
  "applicantType": "individual",
  "correlationId": "req-d34c974c-5935-41b8-a0a9-cedd2407eadd",
  "levelName": "basic-kyc-level",
  "externalUserId": "12672",
  "type": "applicantLevelChanged",
  "sandboxMode": "false",
  "reviewStatus": "init",
  "createdAtMs": "2020-07-23 11:19:33.002",
  "clientId": "coolClientId"
}

videoIdentStatusChanged

{
  "applicantId": "5f8993f93324610009e5885e",
  "inspectionId": "5f8993f93324610009e5885f",
  "applicantType": "individual",
  "correlationId": "req-5a570d5d-e27c-484b-94a9-0f1e9fb2764c",
  "levelName": "kyc_video",
  "externalUserId": "flow-feb1f7ad-b2e2-479a-a4d5-bca5486f7b85",
  "type": "videoIdentStatusChanged",
  "sandboxMode": "false",
  "reviewStatus": "init",
  "videoIdentReviewStatus": "pending",
  "createdAtMs": "2020-10-16 12:37:26.002",
  "clientId": "SumsubClient"
}

{
  "applicantId": "596928690a975a137c5b207e",
  "inspectionId": "596928690a975a137c5b207a",
  "correlationId": "req-a7812631-2c40-4f13-8407-fd42a516f0b0",
  "levelName": "basic-kyc",
  "type": "videoIdentStatusChanged",
  "sandboxMode": "false",
  "reviewResult": {
    "reviewAnswer": "GREEN"
  },
  "reviewStatus": "completed",
  "videoIdentReviewStatus": "pending",
  "createdAtMs": "2020-10-16 12:34:25.003",
  "clientId": "coolClientId"
}

applicantReset

{
  "applicantId": "5f194e74040c3f316bda271c",
  "inspectionId": "5f194e74040c3f316bda271d",
  "applicantType": "individual",
  "correlationId": "req-57fed49a-07b8-4413-bdaa-a1be903769e9",
  "levelName": "basic-kyc-level",
  "externalUserId": "12672",
  "type": "applicantReset",
  "sandboxMode": "false",
  "reviewResult": {
    "reviewAnswer": "GREEN"
  },
  "reviewStatus": "init",
  "createdAtMs": "2021-03-01 11:34:51.104",
  "clientId": "coolClientId"
}

applicantWorkflowCompleted

{
  "applicantId": "64106d6b7d5a2d5159e6b01a",
  "inspectionId": "64106d6b7d5a2d5159e6b01b",
  "applicantType": "individual",
  "correlationId": "req-57fed49a-07b8-4413-bdaa-a1be903769e9",
  "levelName": "basic-kyc-level",
  "sandboxMode": false,
  "externalUserId": "12672",
  "type": "applicantWorkflowCompleted",
  "reviewResult": {
    "reviewAnswer": "RED",
    "rejectLabels": [
      "AGE_REQUIREMENT_MISMATCH"
    ],
    "reviewRejectType": "FINAL",
    "buttonIds": []
  },
  "reviewStatus": "completed",
  "createdAt": "2023-03-14 12:50:27+0000",
  "createdAtMs": "2023-03-14 12:50:27.238",
  "clientId": "coolClientId"
}

applicantActionPending

{
  "applicantId": "5dc158b109494c3cbf431e28",
  "applicantActionId": "5dc2d80ce3cc9b1c1e389c4c",
  "externalApplicantActionId": "id122424234-random-r7otyykndi",
  "inspectionId": "5dc158b109494c3cbf431e29",
  "applicantType": "individual",
  "correlationId": "req-8fbf5a81-339f-43b6-a9a7-290080e9039c",
  "levelName": "basic-action-level",
  "externalUserId": "pid122424235",
  "type": "applicantActionPending",
  "reviewStatus": "completed",
  "createdAtMs": "2020-02-21 13:23:16.001"
}

applicantActionReviewed

{
  "applicantId": "5dc158b109494c3cbf431e28",
  "applicantActionId": "5dc2d80ce3cc9b1c1e389c4c",
  "externalApplicantActionId": "id122424234-random-r7otyykndi",
  "inspectionId": "5dc158b109494c3cbf431e29",
  "correlationId": "req-c9041677-e8dc-446b-ab8f-50b438a40aa8",
  "levelName": "basic-action-level",
  "externalUserId": "id122424234",
  "type": "applicantActionReviewed",
  "reviewResult": {
    "reviewAnswer": "GREEN"
  },
  "reviewStatus": "completed",
  "createdAtMs": "2020-02-21 13:23:19.001"
}

applicantActionOnHold

{
  "applicantId": "5ea867a9772e27d66728c64b",
  "applicantActionId": "5ea867c2772e27d66728c64f",
  "inspectionId": "5ea867a9772e27d66728c64c",
  "correlationId": "req-2c3cce19-c723-4fd0-a2f2-527789f95bcc",
  "levelName": "basic-action-level",
  "externalUserId": "random-4gguvx1oha",
  "type": "applicantActionOnHold",
  "reviewStatus": "init",
  "createdAtMs": "2020-04-28 18:16:09.001"
}