Case management webhooks
This section lists a collection of webhooks related to Case management.
Webhook | Description |
---|---|
kytCaseCreated | New KYT case has been created. |
kytCaseReviewed | KYT case has been reviewed. |
kytCaseStatusChanged | Status of the KYT case has been changed. |
Note
Personal applicant information is not available in the webhook payload. To get this information, use this API method.
Tip
If you are not receiving webhooks, try to check your endpoints using SSL Labs or Docker.
kytCaseCreated
The following example indicates that a new KYT case has been created in the Sumsub system.
{
"applicantId" : "670f85df0578a72bf1131856",
"correlationId" : "da9564f4437c9fcd059f99e0b94fa04d",
"sandboxMode" : true,
"type" : "kytCaseCreated",
"reviewStatus" : "init",
"createdAt" : "2024-11-18 10:49:47+0000",
"createdAtMs" : "2024-11-18 10:49:47.918",
"kytCaseId" : "670f85e00578a72bf113189d"
}
Field | Type | Description |
---|---|---|
applicantId | String | Unique identifier of the applicant. |
correlationId | String | Unique identifier of the event. |
sandboxMode | Boolean | Set to true if the webhook was sent from Sandbox . |
type | String | Webhook type. In this context, it is kytCaseCreated . |
reviewStatus | String | Current status of the KYT case (e.g., init , queued , completed , onHold ). |
createdAt | Date | Date and time when the webhook was created (format yyyy-MM-dd HH:mm:ss+0000 , e.g. 2021-05-14 16:00:25+0000) in UTC. |
createdAtMs | Date | Date and time when the webhook was created, considering milliseconds (format yyyy-MM-dd HH:mm:ss.fff , e.g. 2021-05-14 16:00:25.032 ) in UTC. |
kytCaseId | String | Unique identifier of the KYT case on the Sumsub side. |
kytCaseReviewed
The following example indicates that the KYT case has been reviewed.
{
"applicantId" : "670f85e10578a72bf1131906",
"correlationId" : "da9564f4437c9fcd059f99e0b94fa04d",
"sandboxMode" : true,
"type" : "kytCaseReviewed",
"reviewResult" : {
"reviewAnswer" : "RED",
"reviewRejectType" : "FINAL"
},
"reviewStatus" : "completed",
"createdAt" : "2024-11-18 10:43:45+0000",
"createdAtMs" : "2024-11-18 10:43:45.068",
"kytCaseId" : "670f85e20578a72bf1131950"
}
Field | Type | Description |
---|---|---|
applicantId | String | Unique identifier of the applicant. |
correlationId | String | Unique identifier of the event. |
sandboxMode | Boolean | Set to true if the webhook was sent from Sandbox . |
type | String | Webhook type. In this context, it is kytCaseReviewed . |
reviewResult | Object | Contains extra information on the case verification result, such as reviewAnswer indicating the result and reviewRejectType if the case was rejected. |
reviewAnswer | String | Explains the review result:
|
reviewRejectType | String | Indicates the type of rejection:
|
reviewStatus | String | Current status of the KYT case (e.g., init , queued , completed , onHold ). |
createdAt | Date | Date and time when the webhook was created (format yyyy-MM-dd HH:mm:ss+0000 , e.g. 2021-05-14 16:00:25+0000) in UTC. |
createdAtMs | Date | Date and time when the webhook was created, considering milliseconds (format yyyy-MM-dd HH:mm:ss.fff , e.g. 2021-05-14 16:00:25.032 ) in UTC. |
kytCaseId | String | Unique identifier of the KYT case on the Sumsub side. |
kytCaseStatusChanged
The following example indicates that the status of the KYT case has been changed.
{
"applicantId" : "670f85e10578a72bf1131906",
"correlationId" : "da9564f4437c9fcd059f99e0b94fa04d",
"sandboxMode" : true,
"type" : "kytCaseStatusChanged",
"reviewResult" : {
"reviewAnswer" : "RED",
"reviewRejectType" : "FINAL"
},
"reviewStatus" : "completed",
"createdAt" : "2024-11-18 10:42:42+0000",
"createdAtMs" : "2024-11-18 10:42:42.720",
"kytCaseId" : "670f85e20578a72bf1131950"
}
Field | Type | Description |
---|---|---|
applicantId | String | Unique identifier of the applicant. |
correlationId | String | Unique identifier of the event. |
sandboxMode | Boolean | Set to true if the webhook was sent from Sandbox . |
type | String | Webhook type. In this context, it is kytCaseStatusChanged . |
reviewResult | Object | Contains extra information on the case verification result, such as reviewAnswer indicating the result and reviewRejectType if the case was rejected. |
reviewAnswer | String | Explains the review result:
|
reviewRejectType | String | Indicates the type of rejection:
|
reviewStatus | String | Current status of the KYT case (e.g., init , queued , completed , onHold ). |
createdAt | Date | Date and time when the webhook was created (format yyyy-MM-dd HH:mm:ss+0000 , e.g. 2021-05-14 16:00:25+0000) in UTC. |
createdAtMs | Date | Date and time when the webhook was created, considering milliseconds (format yyyy-MM-dd HH:mm:ss.fff , e.g. 2021-05-14 16:00:25.032 ) in UTC. |
kytCaseId | String | Unique identifier of the KYT case on the Sumsub side. |
Updated 9 days ago