Applicant Webhooks
The "Applicant" serves as a centralized repository consolidating all data pertinent to an individual user within the platform collected with the help of webhooks.
Applicant Webhooks
| Name | Description |
|---|---|
| applicantCreated | It signifies the creation of an applicant profile within the system. No specific action is required from the client or end-user at this stage, and the verification process may not have commenced. |
| applicantInProgress | It denotes that the user has completed all required actions on their end, and the system has commenced background checks. |
| applicantIncomplete | It indicates that the user has initiated the verification process but has not yet provided all the necessary details. As a result, the process remains unfinished. |
| applicantInReview | It is assigned when a compliance officer has initiated a manual review of the verification process. |
| applicantRejected | It signifies that the compliance officer has declined the verification after review. |
| applicantApproved | It denotes that the compliance officer has completed their review and approved the verification. |
| applicantCompleted | It indicates that the user has fulfilled all required actions and provided the necessary data, and all system-side processes related to verification are also finalized. |
| applicantOnHold | It indicates that some kind of background validation cannot be run, manual validation is needed |
| applicantStepPassed | This event occurs when an applicant successfully passes a step in the verification flow. |
| applicantDuplicateDocument | It indicates that the system has detected duplicate document submissions for multiple applicant profiles, requiring further investigation. |
| expiredDocument | This event is triggered when a submitted document has expired |
| additionalDocumentStepError | Indicates an error at the stage of additional document validation |
| applicantDuplicateEmail | It is triggered when the system detects duplicate email addresses associated with multiple applicant profiles, suggesting possible fraud or system errors. |
| applicantDuplicatePhone | It is triggered when the system identifies duplicate phone numbers linked to different applicants, indicating potential fraud or data duplication. |
| amlPositiveCases | This event indicates that the applicant's information matches a record in an anti-money laundering (AML) database, requiring further review and investigation. |
| amlCannotStarted | It denotes that the AML screening process could not be initiated due to missing or incomplete data. |
| amlResultUpdated | This event occurs when the results of the AML screening process are updated, reflecting changes such as clearing a match or confirming a positive case. |
| cryptoAmlResult | This event occurs when you make a request through a public api, the received cryptocurrency wallet verification results will be sent through a webhook that is set up to the application |
| applicantDuplicateCryptoAddress | It indicates that the system has detected duplicate crypto wallet address submissions for multiple applicant profiles, requiring further investigation. |
applicantCreated
{
"type":"applicantCreated",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"timestamp": 1737977546178
}
| Name | Type | Description |
|---|---|---|
| id* | UUID | A unique applicant identifier |
| type* | String | enumerable value |
| externalUserId* | String | A unique applicant identifier on your side. |
| appKey* | UUID | A unique application identifier. |
| timestamp* | Number | event time in milliseconds |
applicantInProgress
{
"type":"applicantInProgress",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"fullName": "John Back",
"previousStatus": "INCOMPLETE",
"newStatus": "IN_PROGRESS",
"timestamp": 1737977546178
}
| Name | Type | Description |
|---|---|---|
| id* | UUID | A unique applicant identifier |
| type* | String | enumerable value |
| externalUserId* | String | A unique applicant identifier on your side. |
| appKey* | UUID | A unique application identifier. |
| fullName | String | An Applicant Full Name |
| previousStatus* | String | enumerable value |
| newStatus* | String | enumerable value |
| timestamp* | Number | event time in milliseconds |
applicantIncomplete
{
"type":"applicantIncomplete",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"fullName": "John Back",
"previousStatus": "INIT",
"newStatus": "INCOMPLETE",
"timestamp": 1737977546178
}
| Name | Type | Description |
|---|---|---|
| id* | UUID | A unique applicant identifier |
| type* | String | enumerable value |
| externalUserId* | String | A unique applicant identifier on your side. |
| appKey* | UUID | A unique application identifier. |
| fullName | String | An Applicant Full Name |
| previousStatus* | String | enumerable value |
| newStatus* | String | enumerable value |
| timestamp* | Number | event time in milliseconds |
applicantInReview
{
"type":"applicantInReview",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"fullName": "John Back",
"timestamp": 1737977546178
}
| Name | Type | Description |
|---|---|---|
| id* | UUID | A unique applicant identifier |
| type* | String | enumerable value |
| externalUserId* | String | A unique applicant identifier on your side. |
| appKey* | UUID | A unique application identifier. |
| fullName | String | An Applicant Full Name |
| timestamp* | Number | event time in milliseconds |
applicantRejected
{
"type":"applicantRejected",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"fullName": "John Back",
"previousStatus": "COMPLETED",
"newStatus": "REJECTED",
"timestamp": 1737977546178
}
| Name | Type | Description |
|---|---|---|
| id* | UUID | A unique applicant identifier |
| type* | String | enumerable value |
| externalUserId* | String | A unique applicant identifier on your side. |
| appKey* | UUID | A unique application identifier. |
| fullName | String | An Applicant Full Name |
| previousStatus* | String | enumerable value |
| newStatus* | String | enumerable value |
| timestamp* | Number | event time in milliseconds |
applicantApproved
{
"type":"applicantApproved",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"fullName": "John Back",
"previousStatus": "COMPLETED",
"newStatus": "APPROVED",
"timestamp": 1737977546178
}
| Name | Type | Description |
|---|---|---|
| id* | UUID | A unique applicant identifier |
| type* | String | enumerable value |
| externalUserId* | String | A unique applicant identifier on your side. |
| appKey* | UUID | A unique application identifier. |
| fullName | String | An Applicant Full Name |
| previousStatus* | String | enumerable value |
| newStatus* | String | enumerable value |
| timestamp* | Number | event time in milliseconds |
applicantCompleted
{
"type":"applicantCompleted",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"fullName": "John Back",
"previousStatus": "INCOMPLETE",
"newStatus": "COMPLETED",
"timestamp": 1737977546178
}
| Name | Type | Description |
|---|---|---|
| id* | UUID | A unique applicant identifier |
| type* | String | enumerable value |
| externalUserId* | String | A unique applicant identifier on your side. |
| appKey* | UUID | A unique application identifier. |
| fullName | String | An Applicant Full Name |
| previousStatus* | String | enumerable value |
| newStatus* | String | enumerable value |
| timestamp* | Number | event time in milliseconds |
applicantOnHold
{
"type":"applicantOnHold",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"previousStatus": "IN_PROGRESS",
"newStatus": "ON_HOLD",
"timestamp": 1737977546178
}
applicantStepPassed
{
"type":"applicantStepPassed",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"stepName": "liveness",
"timestamp": 1737977546178
}
| Name | Type | Description |
|---|---|---|
| id* | UUID | A unique applicant identifier |
| type* | String | enumerable value |
| externalUserId* | String | A unique applicant identifier on your side. |
| appKey* | UUID | A unique application identifier. |
| stepName* | String | enumerable value |
| timestamp* | Number | event time in milliseconds |
applicantDuplicateDocument
{
"type":"applicantDuplicateDocument",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"warning": "APPLICANT_DUPLICATE_DOCUMENT",
"timestamp": 1737977546178
}
| Name | Type | Description |
|---|---|---|
| id* | UUID | A unique applicant identifier |
| type* | String | enumerable value |
| externalUserId* | String | A unique applicant identifier on your side. |
| appKey* | UUID | A unique application identifier. |
| fullName | String | An Applicant Full Name |
| warning* | String | enumerable value |
| timestamp* | Number | event time in milliseconds |
expiredDocument
{
"type":"expiredDocument",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"warning": "EXPIRED_DOCUMENT",
"timestamp": 1737977546178
}
| Name | Type | Description |
|---|---|---|
| id* | UUID | A unique applicant identifier |
| type* | String | enumerable value |
| externalUserId* | String | A unique applicant identifier on your side. |
| appKey* | UUID | A unique application identifier. |
| fullName | String | An Applicant Full Name |
| warning* | String | enumerable value |
| timestamp* | Number | event time in milliseconds |
additionalDocumentStepError
{
"type":"additionalDocumentStepError",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"warning": "ADDITIONAL_DOCUMENT_STEP_ERROR",
"timestamp": 1737977546178
}
| Name | Type | Description |
|---|---|---|
| id* | UUID | A unique applicant identifier |
| type* | String | enumerable value |
| externalUserId* | String | A unique applicant identifier on your side. |
| appKey* | UUID | A unique application identifier. |
| fullName | String | An Applicant Full Name |
| warning* | String | enumerable value |
| timestamp* | Number | event time in milliseconds |
applicantDuplicateEmail
{
"type":"applicantDuplicateEmail",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"warning": "APPLICANT_DUPLICATE_EMAIL",
"timestamp": 1737977546178
}
| Name | Type | Description |
|---|---|---|
| id* | UUID | A unique applicant identifier |
| type* | String | enumerable value |
| externalUserId* | String | A unique applicant identifier on your side. |
| appKey* | UUID | A unique application identifier. |
| fullName | String | An Applicant Full Name |
| warning* | String | enumerable value |
| timestamp* | Number | event time in milliseconds |
applicantDuplicatePhone
{
"type":"applicantDuplicatePhone",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"warning": "APPLICANT_DUPLICATE_PHONE",
"timestamp": 1737977546178
}
| Name | Type | Description |
|---|---|---|
| id* | UUID | A unique applicant identifier |
| type* | String | enumerable value |
| externalUserId* | String | A unique applicant identifier on your side. |
| appKey* | UUID | A unique application identifier. |
| fullName | String | An Applicant Full Name |
| warning* | String | enumerable value |
| timestamp* | Number | event time in milliseconds |
amlPositiveCases
{
"type":"amlPositiveCases",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"warning": "AML_POSITIVE_CASES",
"timestamp": 1737977546178
}
| Name | Type | Description |
|---|---|---|
| id* | UUID | A unique applicant identifier |
| type* | String | enumerable value |
| externalUserId* | String | A unique applicant identifier on your side. |
| appKey* | UUID | A unique application identifier. |
| fullName | String | An Applicant Full Name |
| warning* | String | enumerable value |
| timestamp* | Number | event time in milliseconds |
amlCannotStarted
{
"type":"amlCannotStarted",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"warning": "AML_CANNOT_STARTED",
"timestamp": 1737977546178
}
| Name | Type | Description |
|---|---|---|
| id* | UUID | A unique applicant identifier |
| type* | String | enumerable value |
| externalUserId* | String | A unique applicant identifier on your side. |
| appKey* | UUID | A unique application identifier. |
| fullName | String | An Applicant Full Name |
| warning* | String | enumerable value |
| timestamp* | Number | event time in milliseconds |
amlResultUpdated
{
"type":"amlResultUpdated",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"warning": "AML_RESULT_UPDATED",
"timestamp": 1737977546178
}
| Name | Type | Description |
|---|---|---|
| id* | UUID | A unique applicant identifier |
| type* | String | enumerable value |
| externalUserId* | String | A unique applicant identifier on your side. |
| appKey* | UUID | A unique application identifier. |
| fullName | String | An Applicant Full Name |
| warning* | String | enumerable value |
| timestamp* | Number | event time in milliseconds |
cryptoAmlResult
Success Response
{
"type":"cryptoAmlResult",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"data": {
"type": "WALLET",
"id": "text",
"clientKey": "text",
"applicantId": "text",
"blockchain": "BTC",
"reviewStatus": "UNKNOWN",
"address": "text",
"score": 0,
"amount": "text",
"uof": [
{
"hash": "text",
"forward": false,
"owner": "text",
"score": 0,
"type": "text",
"depth": 0,
"amount": 0,
"address": "text",
"share": 0,
"transactionCount": 0,
"unidentified": false,
"unknown": false,
"amountCur": 0,
"cluster": 0,
"directStamp": 0,
"timestamp": 0,
"listType": "text",
"amountDec": 0,
"directTx": "text"
}
],
"sof": [
{
"hash": "text",
"forward": false,
"owner": "text",
"score": 0,
"type": "text",
"depth": 0,
"amount": 0,
"address": "text",
"share": 0,
"transactionCount": 0,
"unidentified": false,
"unknown": false,
"amountCur": 0,
"cluster": 0,
"directStamp": 0,
"timestamp": 0,
"listType": "text",
"amountDec": 0,
"directTx": "text"
}
],
"addressInfo": {
"address": "text",
"owner": "text",
"description": "text",
"type": {
"id": "text",
"name": "text",
"score": 0
},
"txCount": 0,
"txReceivedCount": 0,
"txSentCount": 0,
"tags": [
[]
],
"balance": {
"amount": "text",
"price": 0,
"priceTimestamp": 0,
"symbol": "text"
},
"firstSeen": 0,
"lastSeen": 0,
"parentCount": 0,
"parentNativeCount": 0,
"addressType": "text",
"conflict": false,
"totalETHTxs": 0,
"totalInternalTxs": 0,
"totalTokensTxs": 0,
"assets": [
{
"supported": false,
"name": "text",
"symbol": "text",
"icon": "text"
}
]
},
"entities": [
{
"id": "text",
"score": 0,
"scoreType": "text",
"name": "text",
"scoreTypeId": "text"
}
],
"isMonitoring": true,
"lastUpdateDate": "2023-01-01T00:00:00Z",
"outdated": false,
"createdAt": "2023-01-01T00:00:00Z",
"timelines": [
{
"id": "text",
"requestUniqueId": "text",
"eventName": "CRYPTO_AML_STATUS_UPDATED",
"applicantId": "text",
"appKey": "text",
"amlId": "text",
"userId": 0,
"device": {},
"geo": {},
"createdAt": "2025-02-09T12:20:36.671Z",
"updatedAt": "2025-02-09T12:20:36.671Z"
}
],
"updatedAt": "2023-01-02T00:00:00Z"
}
"timestamp": 1737977546178
}
Error Response
{
"type":"cryptoAmlResult",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"data": {
"statusCode": 17000,
"error": "Blockchain Address does not find"
},
"timestamp": 1737977546178
}
| Name | Type | Description |
|---|---|---|
| id* | UUID | A unique crypto wallet result identifier |
| type* | String | enumerable value |
| appKey* | UUID | A unique application identifier. |
| data* | Object | Crypto Wallet Details or Error object |
| timestamp* | Number | event time in milliseconds |
applicantDuplicateCryptoAddress
{
"type":"applicantDuplicateCryptoAddress",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"warning": "APPLICANT_DUPLICATE_CRYPTO_ADDRESS",
"timestamp": 1737977546178
}
| Name | Type | Description |
|---|---|---|
| id* | UUID | A unique applicant identifier |
| type* | String | enumerable value |
| externalUserId* | String | A unique applicant identifier on your side. |
| appKey* | UUID | A unique application identifier. |
| fullName | String | An Applicant Full Name |
| warning* | String | enumerable value |
| timestamp* | Number | event time in milliseconds |