---
updatedAt: 2026-10-02T09:39:20.000Z
agentTools:
projectIndex: https://docs.sumsub.com/llms.txt
---
# Transaction monitoring webhooks
Track transaction events and stay updated on transaction status changes with webhooks.
This section lists a collection of webhooks that you may receive during [transaction monitoring](https://docs.sumsub.com/sumsub/docs/transaction-monitoring).
| Webhook | Description |
| :------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [applicantKytTxnCreated](transaction-monitoring-webhooks#applicantkyttxncreated) | Transaction was created successfully by your entity, or by another client as a mirrored transaction (in [Travel Rule](https://docs.sumsub.com/sumsub/docs/travel-rule) scenarios) on your key. |
| [applicantKytTxnApproved](transaction-monitoring-webhooks#applicantkyttxnapproved) | Transaction was approved, and the transfer or deposition of assets/properties can be expected soon. |
| [applicantKytTxnRejected](transaction-monitoring-webhooks#applicantkyttxnrejected) | Checks have been completed, and the review result is — **rejected**. |
| [applicantKytTxnReviewed](https://docs.sumsub.com/sumsub/docs/transaction-monitoring-webhooks#applicantkyttxnreviewed) | Transaction that was previously put on hold was reviewed by the officer and removed from the on-hold queue. You can soon expect the webhook to notify you on the review results. |
| [applicantKytTxnDeleted](https://docs.sumsub.com/sumsub/docs/transaction-monitoring-webhooks#applicantkyttxndeleted) | Transaction and all the related information were deleted. |
| [applicantKytOnHold](transaction-monitoring-webhooks#applicantkytonhold) | Based on the [rules you applied](https://docs.sumsub.com/sumsub/docs/tm-rules), the transaction was put on hold and queued for manual review by the dedicated expert. As soon as the transaction is reviewed, its status will be set to **applicant reviewed**. |
| [applicantKytTxnAwaitingUser](transaction-monitoring-webhooks#applicantkyttxnawaitinguser) | Transaction status was set to **awaiting user**. This means that the rule requiring the applicant action, such as passing an additional check, was triggered. The scoring is stopped until the applicant completes the required flow. |
| [applicantKytTxnDataChanged](transaction-monitoring-webhooks#applicantkyttxndatachanged) | Transaction data was updated. Sent when the transaction hash is added or changed, when the party that initiated the Travel Rule request cancels it (both parties are notified), or when the VASP confirms wallet ownership and the counterparty wallet details are added to the transaction. |
| applicantRiskLevelChanged | Applicant risk level has changed, either automatically (based on scoring) or manually (via override). |
| [amlCaseApproved](https://docs.sumsub.com/sumsub/docs/transaction-monitoring-webhooks#amlcaseapproved) | AML case review was completed and the case was approved (`GREEN`). This means that no significant AML-related issues were found for the transaction participant. |
| [amlCaseRejected](https://docs.sumsub.com/sumsub/docs/transaction-monitoring-webhooks#amlcaserejected) | AML case review was completed and the case was rejected (`RED`). This means that the transaction participant failed the AML screening. |
| [amlCaseOnHold](transaction-monitoring-webhooks#amlcaseonhold) | AML case review was placed on hold (`YELLOW`). This means that the case requires additional manual review before a final decision is made. |
### Note
Personal applicant information is not available in the webhook payload. To get this information, use [this API method](/reference/get-applicant-data).
### Tip
If you are not receiving webhooks, try to check your endpoints using [SSL Labs](https://www.ssllabs.com/ssltest/) or Docker.
# applicantKytTxnCreated
```json
{
"applicantType": "individual",
"correlationId": "req-9b3a4f51-c0a7-4d3a-9f2c-9d7c1d4f7d22",
"sandboxMode": false,
"externalUserId": "customExternalUserId",
"type": "applicantKytTxnCreated",
"reviewStatus": "init",
"createdAtMs": "2025-11-17 17:26:49.676",
"clientId": "coolClientId",
"kytTxnId": "691b5ad93f7d5f23100611ca",
"kytDataTxnId": "9682adb6-b2cc-429c-acae-f36312c34a95",
"kytTxnType": "travelRule"
}
```
| Field | Type | Description |
| ------------------ | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `applicantType` | String | Defines the applicant entity type:individual — for applicants registered and checked as individuals.company — for applicants registered and checked as legal entities.
|
| `correlationId` | String | A shared identifier assigned to the originating request and propagated across all related events. Multiple events may share the same `correlationId` when triggered by the same operation. |
| `sandboxMode` | Boolean | Set to `true` if the webhook was sent from [Sandbox](https://docs.sumsub.com/sumsub/docs/sandbox-mode). |
| `testMode` | Boolean | \[Optional] Present and set to `true` only if the webhook was sent manually in the Webhook manager. This field is omitted for real (production) webhooks — check for its presence or `true`, not for `false`.
Independent of `sandboxMode`, which indicates the Sandbox environment rather than a manual test send. |
| `externalUserId` | String | Unique applicant identifier as registered on your side.
When [creating an applicant](https://docs.sumsub.com/sumsub/reference/create-applicants), you can generate and add the `externalUserId` manually, or it will be automatically generated and added to the applicant profile by Sumsub. |
| `type` | String | Webhook type. In this context, it is `applicantKytTxnCreated`. |
| `reviewStatus` | String | Indicates the current transaction status (`init`, `onHold`, `awaitingUser`, `completed`). |
| `createdAtMs` | Date | Date and time when the webhook was created, considering milliseconds (format `yyyy-MM-dd HH:mm:ss.fff`, for example, `2021-05-14 16:00:25.032`) in UTC. |
| `clientId` | String | Unique identifier of you as our client in the Sumsub system.
This identifier is assigned to you when you are registered in and get access to the Sumsub system. It usually resembles your name or your company name. `clientId` is automatically added to the applicant profile when it is created. |
| `kytTxnId` | String | Unique transaction identifier (`.id`) on the Sumsub side. |
| `kytDataTxnId` | String | Unique transaction identifier (`data.txnId`) on your side. |
| `kytTxnType` | String | Transaction type. Expects values:financekyctravelRuleuserPlatformEvent
|
| `travelRuleStatus` | String, optional | Status of the Travel Rule data exchange when the webhook was sent. It has the same value as `travelRuleInfo.status` in the transaction.
The field is present only for transactions with a Travel Rule exchange. It is omitted when no status is assigned yet, which is typical for `applicantKytTxnCreated`. |
# applicantKytTxnApproved
```json
{
"applicantId": "634829375766b80001a40152",
"applicantType": "individual",
"correlationId": "f24f6616020245053139a6537303a251",
"sandboxMode": false,
"externalUserId": "customExternalUserId",
"type": "applicantKytTxnApproved",
"reviewResult": {
"reviewAnswer": "GREEN"
},
"reviewStatus": "completed",
"createdAt": "2024-04-24 11:15:09+0000",
"createdAtMs": "2024-04-24 11:15:09.446",
"clientId": "coolClientId",
"kytTxnId": "64a7dc05fbf57c624afcb72d",
"kytDataTxnId": "uauu08x44xexbohyh4lkp9",
"kytTxnType": "finance"
}
```
| Field | Type | Description |
| ------------------ | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `applicantId` | String | Unique identifier of the applicant in the Sumsub system. |
| `applicantType` | String | Defines the applicant entity type:individual — for applicants registered and checked as individuals.company — for applicants registered and checked as legal entities.
|
| `correlationId` | String | A shared identifier assigned to the originating request and propagated across all related events. Multiple events may share the same `correlationId` when triggered by the same operation. |
| `sandboxMode` | Boolean | Set to `true` if the webhook was sent from [Sandbox](https://docs.sumsub.com/sumsub/docs/sandbox-mode). |
| `testMode` | Boolean | \[Optional] Present and set to `true` only if the webhook was sent manually in the Webhook manager. This field is omitted for real (production) webhooks — check for its presence or `true`, not for `false`.
Independent of `sandboxMode`, which indicates the Sandbox environment rather than a manual test send. |
| `externalUserId` | String | Unique applicant identifier as registered on your side.
When [creating an applicant](https://docs.sumsub.com/sumsub/reference/create-applicants), you can generate and add the `externalUserId` manually, or it will be automatically generated and added to the applicant profile by Sumsub. |
| `type` | String | Webhook type. In this context, it is `applicantKytTxnApproved`. |
| `reviewResult` | [Object](https://docs.sumsub.com/sumsub/reference/get-transaction#reviewresult-attributes) | Contains extra information on the transaction verification results. |
| `reviewStatus` | String | Indicates the current transaction status (`init`, `onHold`, `awaitingUser`, `completed`). |
| `createdAt` | Date | Date and time when the webhook was created (format `yyyy-MM-dd HH:mm:ss+0000`, for example, `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`, for example, `2021-05-14 16:00:25.032`) in UTC. |
| `clientId` | String | Unique identifier of you as our client in the Sumsub system.
This identifier is assigned to you when you are registered in and get access to the Sumsub system. It usually resembles your name or your company name. `clientId` is automatically added to the applicant profile when it is created. |
| `kytTxnId` | String | Unique transaction identifier (`.id`) on the Sumsub side. |
| `kytDataTxnId` | String | Unique transaction identifier (`data.txnId`) on your side. |
| `kytTxnType` | String | Transaction type. Expects values:financekyctravelRuleuserPlatformEvent
|
| `travelRuleStatus` | String, optional | Status of the Travel Rule data exchange when the webhook was sent. It has the same value as `travelRuleInfo.status` in the transaction.
The field is present only for transactions with a Travel Rule exchange. It is omitted when no status is assigned yet. |
# applicantKytTxnRejected
```json
{
"applicantId": "634829375766b80001a40152",
"applicantType": "individual",
"correlationId": "0f5a7c828bab750775564534fc0470a8",
"sandboxMode": false,
"externalUserId": "customExternalUserId",
"type": "applicantKytTxnRejected",
"reviewResult": {
"reviewAnswer": "RED",
"reviewRejectType": "FINAL"
},
"reviewStatus": "completed",
"createdAtMs": "2024-04-24 11:15:09.446",
"clientId": "coolClientId",
"kytTxnId": "64a7dc05fbf57c624afcb72d",
"kytDataTxnId": "j8bqz29yn491vksi9qfydw",
"kytTxnType": "finance"
}
```
| Field | Type | Description |
| ------------------ | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `applicantId` | String | Unique identifier of the applicant in the Sumsub system. |
| `applicantType` | String | Defines the applicant entity type:individual — for applicants registered and checked as individuals.company — for applicants registered and checked as legal entities.
|
| `correlationId` | String | A shared identifier assigned to the originating request and propagated across all related events. Multiple events may share the same `correlationId` when triggered by the same operation. |
| `sandboxMode` | Boolean | Set to `true` if the webhook was sent from [Sandbox](https://docs.sumsub.com/sumsub/docs/sandbox-mode). |
| `testMode` | Boolean | \[Optional] Present and set to `true` only if the webhook was sent manually in the Webhook manager. This field is omitted for real (production) webhooks — check for its presence or `true`, not for `false`.
Independent of `sandboxMode`, which indicates the Sandbox environment rather than a manual test send. |
| `externalUserId` | String | Unique applicant identifier as registered on your side.
When [creating an applicant](https://docs.sumsub.com/sumsub/reference/create-applicants), you can generate and add the `externalUserId` manually, or it will be automatically generated and added to the applicant profile by Sumsub. |
| `type` | String | Webhook type. In this context, it is `applicantKytTxnRejected`. |
| `reviewResult` | [Object](https://docs.sumsub.com/sumsub/reference/get-transaction#reviewresult-attributes) | Contains extra information on the transaction verification results. |
| `reviewStatus` | String | Indicates the current transaction status (`init`, `onHold`, `awaitingUser`, `completed`). |
| `createdAtMs` | Date | Date and time when the webhook was created, considering milliseconds (format `yyyy-MM-dd HH:mm:ss.fff`, for example, `2021-05-14 16:00:25.032`) in UTC. |
| `clientId` | String | Unique identifier of you as our client in the Sumsub system.
This identifier is assigned to you when you are registered in and get access to the Sumsub system. It usually resembles your name or your company name. `clientId` is automatically added to the applicant profile when it is created. |
| `kytTxnId` | String | Unique transaction identifier (`.id`) on the Sumsub side. |
| `kytDataTxnId` | String | Unique transaction identifier (`data.txnId`) on your side. |
| `kytTxnType` | String | Transaction type. Expects values:financekyctravelRuleuserPlatformEvent
|
| `travelRuleStatus` | String, optional | Status of the Travel Rule data exchange when the webhook was sent. It has the same value as `travelRuleInfo.status` in the transaction.
The field is present only for transactions with a Travel Rule exchange. It is omitted when no status is assigned yet. |
# applicantKytTxnReviewed
```json
{
"applicantId": "634829375766b80001a40152",
"applicantType": "individual",
"correlationId": "0f5a7c828bab750775564534fc0470a8",
"sandboxMode": false,
"externalUserId": "customExternalUserId",
"type": "applicantKytTxnReviewed",
"reviewResult": {
"reviewAnswer": "RED",
"reviewRejectType": "FINAL"
},
"reviewStatus": "completed",
"createdAtMs": "2024-04-24 11:15:09.446",
"clientId": "coolClientId",
"kytTxnId": "64a7dc05fbf57c624afcb72d",
"kytDataTxnId": "j8bqz29yn491vksi9qfydw",
"kytTxnType": "finance"
}
```
| Field | Type | Description |
| ------------------ | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `applicantId` | String | Unique identifier of the applicant in the Sumsub system. |
| `applicantType` | String | Defines the applicant entity type:individual — for applicants registered and checked as individuals.company — for applicants registered and checked as legal entities.
|
| `correlationId` | String | A shared identifier assigned to the originating request and propagated across all related events. Multiple events may share the same `correlationId` when triggered by the same operation. |
| `sandboxMode` | Boolean | Set to `true` if the webhook was sent from [Sandbox](https://docs.sumsub.com/sumsub/docs/sandbox-mode). |
| `testMode` | Boolean | \[Optional] Present and set to `true` only if the webhook was sent manually in the Webhook manager. This field is omitted for real (production) webhooks — check for its presence or `true`, not for `false`.
Independent of `sandboxMode`, which indicates the Sandbox environment rather than a manual test send. |
| `externalUserId` | String | Unique applicant identifier as registered on your side.
When [creating an applicant](https://docs.sumsub.com/sumsub/reference/create-applicants), you can generate and add the `externalUserId` manually, or it will be automatically generated and added to the applicant profile by Sumsub. |
| `type` | String | Webhook type. In this context, it is `applicantKytTxnReviewed`. |
| `reviewResult` | [Object](https://docs.sumsub.com/sumsub/reference/get-transaction#reviewresult-attributes) | Contains extra information on the transaction verification results. |
| `reviewStatus` | String | Indicates the current transaction status (`init`, `onHold`, `awaitingUser`, `completed`). |
| `createdAtMs` | Date | Date and time when the webhook was created, considering milliseconds (format `yyyy-MM-dd HH:mm:ss.fff`, for example, `2021-05-14 16:00:25.032`) in UTC. |
| `clientId` | String | Unique identifier of you as our client in the Sumsub system.
This identifier is assigned to you when you are registered in and get access to the Sumsub system. It usually resembles your name or your company name. `clientId` is automatically added to the applicant profile when it is created. |
| `kytTxnId` | String | Unique transaction identifier (`.id`) on the Sumsub side. |
| `kytDataTxnId` | String | Unique transaction identifier (`data.txnId`) on your side. |
| `kytTxnType` | String | Transaction type. Expects values:financekyctravelRuleuserPlatformEvent
|
| `travelRuleStatus` | String, optional | Status of the Travel Rule data exchange when the webhook was sent. It has the same value as `travelRuleInfo.status` in the transaction.
The field is present only for transactions with a Travel Rule exchange. It is omitted when no status is assigned yet. |
# applicantKytTxnDeleted
```json
{
"applicantId": "634829375766b80001a40152",
"applicantType": "individual",
"correlationId": "0f5a7c828bab750775564534fc0470a8",
"sandboxMode": false,
"externalUserId": "customExternalUserId",
"type": "applicantKytTxnDeleted",
"reviewStatus": "completed",
"createdAtMs": "2024-04-24 11:15:09.446",
"clientId": "coolClientId",
"kytTxnId": "64a7dc05fbf57c624afcb72d",
"kytDataTxnId": "j8bqz29yn491vksi9qfydw",
"kytTxnType": "finance"
}
```
| Field | Type | Description |
| ------------------ | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `applicantId` | String | Unique identifier of the applicant in the Sumsub system. |
| `applicantType` | String | Defines the applicant entity type:individual — for applicants registered and checked as individuals.company — for applicants registered and checked as legal entities.
|
| `correlationId` | String | A shared identifier assigned to the originating request and propagated across all related events. Multiple events may share the same `correlationId` when triggered by the same operation. |
| `sandboxMode` | Boolean | Set to `true` if the webhook was sent from [Sandbox](https://docs.sumsub.com/sumsub/docs/sandbox-mode). |
| `testMode` | Boolean | \[Optional] Present and set to `true` only if the webhook was sent manually in the Webhook manager. This field is omitted for real (production) webhooks — check for its presence or `true`, not for `false`.
Independent of `sandboxMode`, which indicates the Sandbox environment rather than a manual test send. |
| `externalUserId` | String | Unique applicant identifier as registered on your side.
When [creating an applicant](https://docs.sumsub.com/sumsub/reference/create-applicants), you can generate and add the `externalUserId` manually, or it will be automatically generated and added to the applicant profile by Sumsub. |
| `type` | String | Webhook type. In this context, it is `applicantKytTxnDeleted`. |
| `reviewStatus` | String | Indicates the current transaction status (`init`, `onHold`, `awaitingUser`, `completed`). |
| `createdAtMs` | Date | Date and time when the webhook was created, considering milliseconds (format `yyyy-MM-dd HH:mm:ss.fff`, for example, `2021-05-14 16:00:25.032`) in UTC. |
| `clientId` | String | Unique identifier of you as our client in the Sumsub system.
This identifier is assigned to you when you are registered in and get access to the Sumsub system. It usually resembles your name or your company name. `clientId` is automatically added to the applicant profile when it is created. |
| `kytTxnId` | String | Unique transaction identifier (`.id`) on the Sumsub side. |
| `kytDataTxnId` | String | Unique transaction identifier (`data.txnId`) on your side. |
| `kytTxnType` | String | Transaction type. Expects values:financekyctravelRuleuserPlatformEvent
|
| `travelRuleStatus` | String, optional | Status of the Travel Rule data exchange when the webhook was sent. It has the same value as `travelRuleInfo.status` in the transaction.
The field is present only for transactions with a Travel Rule exchange. It is omitted when no status is assigned yet. |
# applicantKytOnHold
```json
{
"applicantId": "634829375766b80001a40152",
"applicantType": "individual",
"correlationId": "98d4dac61c977c1b3f81d6ab78d29c3c",
"sandboxMode": false,
"externalUserId": "customExternalUserId",
"type": "applicantKytOnHold",
"reviewStatus": "onHold",
"createdAtMs": "2024-04-24 11:15:09.446",
"clientId": "coolClientId",
"kytTxnId": "64a7dc05fbf57c624afcb72d",
"kytDataTxnId": "j8bqz29yn491vksi9qfydw",
"kytTxnType": "finance"
}
```
| Field | Type | Description |
| ------------------ | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `applicantId` | String | Unique identifier of the applicant in the Sumsub system. |
| `applicantType` | String | Defines the applicant entity type:individual — for applicants registered and checked as individuals.company — for applicants registered and checked as legal entities.
|
| `correlationId` | String | A shared identifier assigned to the originating request and propagated across all related events. Multiple events may share the same `correlationId` when triggered by the same operation. |
| `sandboxMode` | Boolean | Set to `true` if the webhook was sent from [Sandbox](https://docs.sumsub.com/sumsub/docs/sandbox-mode). |
| `testMode` | Boolean | \[Optional] Present and set to `true` only if the webhook was sent manually in the Webhook manager. This field is omitted for real (production) webhooks — check for its presence or `true`, not for `false`.
Independent of `sandboxMode`, which indicates the Sandbox environment rather than a manual test send. |
| `externalUserId` | String | Unique applicant identifier as registered on your side.
When [creating an applicant](https://docs.sumsub.com/sumsub/reference/create-applicants), you can generate and add the `externalUserId` manually, or it will be automatically generated and added to the applicant profile by Sumsub. |
| `type` | String | Webhook type. In this context, it is `applicantKytOnHold`. |
| `reviewStatus` | String | Indicates the current transaction status (`init`, `onHold`, `awaitingUser`, `completed`). |
| `createdAtMs` | Date | Date and time when the webhook was created, considering milliseconds (format `yyyy-MM-dd HH:mm:ss.fff`, for example, `2021-05-14 16:00:25.032`) in UTC. |
| `clientId` | String | Unique identifier of you as our client in the Sumsub system.
This identifier is assigned to you when you are registered in and get access to the Sumsub system. It usually resembles your name or your company name. `clientId` is automatically added to the applicant profile when it is created. |
| `kytTxnId` | String | Unique transaction identifier (`.id`) on the Sumsub side. |
| `kytDataTxnId` | String | Unique transaction identifier (`data.txnId`) on your side. |
| `kytTxnType` | String | Transaction type. Expects values:financekyctravelRuleuserPlatformEvent
|
| `travelRuleStatus` | String, optional | Status of the Travel Rule data exchange when the webhook was sent. It has the same value as `travelRuleInfo.status` in the transaction.
The field is present only for transactions with a Travel Rule exchange. It is omitted when no status is assigned yet. |
# applicantKytTxnAwaitingUser
```json
{
"applicantId": "6447b564728bf40939a7664f",
"applicantType": "individual",
"correlationId": "7310f3ffddbff223cdf10221cdf12064",
"sandboxMode": false,
"externalUserId": "customExternalUserId",
"type": "applicantKytTxnAwaitingUser",
"reviewStatus": "awaitingUser",
"createdAtMs": "2023-12-11 10:41:54.431",
"clientId": "coolClientId",
"kytTxnId": "6576e772b2f80732714d1de0",
"kytDataTxnId": "m26m980m9jd7pozq72se4",
"kytTxnType": "finance"
}
```
| Field | Type | Description |
| ------------------ | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `applicantId` | String | Unique identifier of the applicant in the Sumsub system. |
| `applicantType` | String | Defines the applicant entity type:individual — for applicants registered and checked as individuals.company — for applicants registered and checked as legal entities.
|
| `correlationId` | String | A shared identifier assigned to the originating request and propagated across all related events. Multiple events may share the same `correlationId` when triggered by the same operation. |
| `sandboxMode` | Boolean | Set to `true` if the webhook was sent from [Sandbox](https://docs.sumsub.com/sumsub/docs/sandbox-mode). |
| `testMode` | Boolean | \[Optional] Present and set to `true` only if the webhook was sent manually in the Webhook manager. This field is omitted for real (production) webhooks — check for its presence or `true`, not for `false`.
Independent of `sandboxMode`, which indicates the Sandbox environment rather than a manual test send. |
| `externalUserId` | String | Unique applicant identifier as registered on your side.
When [creating an applicant](https://docs.sumsub.com/sumsub/reference/create-applicants), you can generate and add the `externalUserId` manually, or it will be automatically generated and added to the applicant profile by Sumsub. |
| `type` | String | Webhook type. In this context, it is `applicantKytTxnAwaitingUser`. |
| `reviewStatus` | String | Indicates the current transaction status (`init`, `onHold`, `awaitingUser`, `completed`). |
| `createdAtMs` | Date | Date and time when the webhook was created, considering milliseconds (format `yyyy-MM-dd HH:mm:ss.fff`, for example, `2021-05-14 16:00:25.032`) in UTC. |
| `clientId` | String | Unique identifier of you as our client in the Sumsub system.
This identifier is assigned to you when you are registered in and get access to the Sumsub system. It usually resembles your name or your company name. `clientId` is automatically added to the applicant profile when it is created. |
| `kytTxnId` | String | Unique transaction identifier (`.id`) on the Sumsub side. |
| `kytDataTxnId` | String | Unique transaction identifier (`data.txnId`) on your side. |
| `kytTxnType` | String | Transaction type. Expects values:financekyctravelRuleuserPlatformEvent
|
| `travelRuleStatus` | String, optional | Status of the Travel Rule data exchange when the webhook was sent. It has the same value as `travelRuleInfo.status` in the transaction.
The field is present only for transactions with a Travel Rule exchange. It is omitted when no status is assigned yet. |
# applicantKytTxnDataChanged
```json
{
"applicantId": "6447b564728bf40939a7664f",
"applicantType": "individual",
"correlationId": "fb36d7a2f2e1ac15773ec9a56f999dde",
"sandboxMode": false,
"externalUserId": "customExternalUserId",
"type": "applicantKytTxnDataChanged",
"reviewResult": {
"reviewAnswer": "GREEN"
},
"reviewStatus": "completed",
"createdAtMs": "2024-01-24 07:38:34.994",
"clientId": "coolClientId",
"kytTxnId": "6576e772b2f80732714d1de0",
"kytDataTxnId": "m26m980m9jd7pozq72se4",
"kytTxnType": "finance"
}
```
| Field | Type | Description |
| ------------------ | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `applicantId` | String | Unique identifier of the applicant in the Sumsub system. |
| `applicantType` | String | Defines the applicant entity type:individual — for applicants registered and checked as individuals.company — for applicants registered and checked as legal entities.
|
| `correlationId` | String | A shared identifier assigned to the originating request and propagated across all related events. Multiple events may share the same `correlationId` when triggered by the same operation. |
| `sandboxMode` | Boolean | Set to `true` if the webhook was sent from [Sandbox](https://docs.sumsub.com/sumsub/docs/sandbox-mode). |
| `testMode` | Boolean | \[Optional] Present and set to `true` only if the webhook was sent manually in the Webhook manager. This field is omitted for real (production) webhooks — check for its presence or `true`, not for `false`.
Independent of `sandboxMode`, which indicates the Sandbox environment rather than a manual test send. |
| `externalUserId` | String | Unique applicant identifier as registered on your side.
When [creating an applicant](https://docs.sumsub.com/sumsub/reference/create-applicants) , you can generate and add the `externalUserId` manually, or it will be automatically generated and added to the applicant profile by Sumsub. |
| `type` | String | Webhook type. In this context, it is `applicantKytTxnDataChanged`. |
| `reviewResult` | [Object](https://docs.sumsub.com/sumsub/reference/get-transaction#reviewresult-attributes) | Contains extra information on the transaction verification results. |
| `reviewStatus` | String | Indicates the current transaction status (`init`, `onHold`, `awaitingUser`, `completed`). |
| `createdAtMs` | Date | Date and time when the webhook was created, considering milliseconds (format `yyyy-MM-dd HH:mm:ss.fff`, for example, `2021-05-14 16:00:25.032`) in UTC. |
| `clientId` | String | Unique identifier of you as our client in the Sumsub system.
This identifier is assigned to you when you are registered in and get access to the Sumsub system. It usually resembles your name or your company name. `clientId` is automatically added to the applicant profile when it is created. |
| `kytTxnId` | String | Unique transaction identifier (`.id`) on the Sumsub side. |
| `kytDataTxnId` | String | Unique transaction identifier (`data.txnId`) on your side. |
| `kytTxnType` | String | Transaction type. Expects values:financekyctravelRuleuserPlatformEvent
|
| `travelRuleStatus` | String, optional | Status of the Travel Rule data exchange when the webhook was sent. It has the same value as `travelRuleInfo.status` in the transaction.
The field is present only for transactions with a Travel Rule exchange. It is omitted when no status is assigned yet. |
# applicantRiskLevelChanged
```json
{
"applicantId": "5f194e74040c3f316bda271c",
"inspectionId": "5f194e74040c3f316bda271d",
"applicantType": "individual",
"correlationId": "req-d34c974c-5935-41b8-a0a9-cedd2407eadd",
"levelName": "id-and-liveness",
"externalUserId": "12672",
"type": "applicantRiskLevelChanged",
"sandboxMode": false,
"reviewStatus": "init",
"createdAtMs": "2020-07-23 11:19:33.002",
"clientId": "coolClientId"
}
```
| Field | Type | Description |
| ---------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `applicantId` | String | Unique identifier of the applicant in the Sumsub system. |
| `inspectionId` | String | Unique combination of digits and characters previously used to identify all actions related to the applicant's ID documents. Added automatically when the applicant is created.
⚠️ As of now, inspectionId is deprecated but still returned in the webhook. |
| `applicantType` | String | Defines the applicant entity type:individual — for applicants registered and checked as individuals.company — for applicants registered and checked as legal entities.
|
| `correlationId` | String | A shared identifier assigned to the originating request and propagated across all related events. Multiple events may share the same `correlationId` when triggered by the same operation. |
| `levelName` | String | Name of the verification level the applicant has to go through. |
| `externalUserId` | String | Unique applicant identifier as registered on your side.
When [creating an applicant](https://docs.sumsub.com/sumsub/reference/create-applicants) , you can generate and add the `externalUserId` manually, or it will be automatically generated and added to the applicant profile by Sumsub. |
| `type` | String | Webhook type. In this context, it is `applicantRiskLevelChanged`. |
| `sandboxMode` | Boolean | Set to `true` if the webhook was sent from [Sandbox](https://docs.sumsub.com/sumsub/docs/sandbox-mode). |
| `testMode` | Boolean | \[Optional] Present and set to `true` only if the webhook was sent manually in the Webhook manager. This field is omitted for real (production) webhooks — check for its presence or `true`, not for `false`.
Independent of `sandboxMode`, which indicates the Sandbox environment rather than a manual test send. |
| `reviewStatus` | String | Indicates the current transaction status (`init`, `onHold`, `awaitingUser`, `completed`). |
| `createdAtMs` | Date | Date and time when the webhook was created, considering milliseconds (format `yyyy-MM-dd HH:mm:ss.fff`, for example, `2021-05-14 16:00:25.032`) in UTC. |
| `clientId` | String | Unique identifier of you as our client in the Sumsub system.
This identifier is assigned to you when you are registered in and get access to the Sumsub system. It usually resembles your name or your company name. `clientId` is automatically added to the applicant profile when it is created. |
# amlCaseApproved
```json
{
"correlationId": "26e4b45a9a0e3e8715de1b8dba0851fa",
"sandboxMode": false,
"type": "amlCaseApproved",
"reviewResult": {
"reviewAnswer": "GREEN"
},
"reviewStatus": "completed",
"createdAtMs": "2023-08-30 10:03:20.907",
"amlCaseId": "64baa015ebc52e736d147e8c",
"clientId": "coolClientId"
}
```
| Field | Type | Description |
| --------------------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `correlationId` | String | Shared identifier assigned to the originating request and propagated across all related events. Multiple events may share the same `correlationId` when triggered by the same operation. |
| `sandboxMode` | Boolean | Indicates whether the webhook was sent from Sandbox. |
| `testMode` | Boolean | \[Optional] Present and set to `true` only if the webhook was sent manually in the Webhook manager. This field is omitted for real (production) webhooks — check for its presence or `true`, not for `false`.
Independent of `sandboxMode`, which indicates the Sandbox environment rather than a manual test send. |
| `type` | String | Webhook event type: `amlCaseApproved`. |
| `reviewResult` | [Object](https://docs.sumsub.com/sumsub/reference/get-transaction#reviewresult-attributes) | Contains extra information on the AML case review results. |
| `reviewResult.reviewAnswer` | String | `GREEN` (approved), `RED` (rejected), or `YELLOW `(on hold). |
| `reviewStatus` | String | Indicates the current AML case status (`onHold`, `completed`). |
| `createdAtMs` | Date | Date and time when the webhook was created, considering milliseconds (format `yyyy-MM-dd HH:mm:ss.fff`, for example, `2021-05-14 16:00:25.032`) in UTC. |
| `amlCaseId` | String | Unique identifier of the AML case. |
| `clientId` | String | Unique identifier of you as our client in the Sumsub system.
This identifier is assigned to you when you are registered in and get access to the Sumsub system. It usually resembles your name or your company name. `clientId` is automatically added to the applicant profile when it is created. |
# amlCaseRejected
```json
{
"correlationId": "f1510d9aee2f7d30c7eb33cb59f24c3c",
"sandboxMode": false,
"type": "amlCaseRejected",
"reviewResult": {
"reviewAnswer": "RED"
},
"reviewStatus": "completed",
"createdAtMs": "2023-08-30 10:02:36.496",
"amlCaseId": "63652066f11034000121a52b",
"clientId": "coolClientId"
}
```
| Field | Type | Description |
| --------------------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `correlationId` | String | Shared identifier assigned to the originating request and propagated across all related events. Multiple events may share the same `correlationId` when triggered by the same operation. |
| `sandboxMode` | Boolean | Indicates whether the webhook was sent from Sandbox. |
| `testMode` | Boolean | \[Optional] Present and set to `true` only if the webhook was sent manually in the Webhook manager. This field is omitted for real (production) webhooks — check for its presence or `true`, not for `false`.
Independent of `sandboxMode`, which indicates the Sandbox environment rather than a manual test send. |
| `type` | String | Webhook event type: `amlCaseRejected`. |
| `reviewResult` | [Object](https://docs.sumsub.com/sumsub/reference/get-transaction#reviewresult-attributes) | Contains extra information on the AML case review results. |
| `reviewResult.reviewAnswer` | String | `GREEN` (approved), `RED` (rejected), or `YELLOW `(on hold). |
| `reviewStatus` | String | Indicates the current AML case status (`onHold`, `completed`). |
| `createdAtMs` | Date | Date and time when the webhook was created, considering milliseconds (format `yyyy-MM-dd HH:mm:ss.fff`, for example, `2021-05-14 16:00:25.032`) in UTC. |
| `amlCaseId` | String | Unique identifier of the AML case. |
| `clientId` | String | Unique identifier of you as our client in the Sumsub system.
This identifier is assigned to you when you are registered in and get access to the Sumsub system. It usually resembles your name or your company name. `clientId` is automatically added to the applicant profile when it is created. |
# amlCaseOnHold
```json
{
"correlationId": "da9564f4437c9fcd059f99e0b94fa04d",
"sandboxMode": false,
"type": "amlCaseOnHold",
"reviewResult": {
"reviewAnswer": "YELLOW"
},
"reviewStatus": "onHold",
"createdAtMs": "2023-08-30 09:59:52.864",
"amlCaseId": "63d7d1bac92045720c5e354a",
"clientId": "coolClientId"
}
```
| Field | Type | Description |
| --------------------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `correlationId` | String | Shared identifier assigned to the originating request and propagated across all related events. Multiple events may share the same `correlationId` when triggered by the same operation. |
| `sandboxMode` | Boolean | Indicates whether the webhook was sent from [Sandbox](https://docs.sumsub.com/sumsub/docs/test-in-sandbox). |
| `testMode` | Boolean | \[Optional] Present and set to `true` only if the webhook was sent manually in the Webhook manager. This field is omitted for real (production) webhooks — check for its presence or `true`, not for `false`.
Independent of `sandboxMode`, which indicates the Sandbox environment rather than a manual test send. |
| `type` | String | Webhook event type: `amlCaseOnHold`. |
| `reviewResult` | [Object](https://docs.sumsub.com/sumsub/reference/get-transaction#reviewresult-attributes) | Contains extra information on the AML case review results. |
| `reviewResult.reviewAnswer` | String | `GREEN` (approved), `RED` (rejected), or `YELLOW `(on hold). |
| `reviewStatus` | String | Indicates the current AML case status (`onHold`, `completed`). |
| `createdAtMs` | Date | Date and time when the webhook was created, considering milliseconds (format `yyyy-MM-dd HH:mm:ss.fff`, for example, `2021-05-14 16:00:25.032`) in UTC. |
| `amlCaseId` | String | Unique identifier of the AML case. |
| `clientId` | String | Unique identifier of you as our client in the Sumsub system.
This identifier is assigned to you when you are registered in and get access to the Sumsub system. It usually resembles your name or your company name. `clientId` is automatically added to the applicant profile when it is created. |