Client KYB Status

This event is triggered when the compliance status, as a result of the KYB process, is anything other than complete for a client.

https://<customerHost:Port>/webhook

Header

Field	Description
Content-Type	application/json

Request example

example webhook when application is submitted and some required document is not submitted

curl --location --request POST 'https://<customerHost:Port>/webhook' \
-H 'content-type: application/json' \
-d '{
    "clientHashId": "86ce8d7b-f3fa-46d5-8d1c-53212aade5b5",
    "customerHashId": "857dc08e-dffa-4e9a-ad96-79041c8a7025",
    "clientId": "NIM1622197836971",
    "caseId": "a9ec3c55-f06d-4f0b-9f67-e89968b861bf",
    "newClientName": "Onboarding",
    "complianceStatus": "IN_PROGRESS",
    "status": "Pending",
    "template": "CARD_CLIENT_KYB_STATUS_WEBHOOK"
}'

example webhook when application is submitted and agent has requested for RFI

curl --location --request POST 'https://<customerHost:Port>/webhook' \
-H 'content-type: application/json' \
-d '{
    "clientHashId": "86ce8d7b-f3fa-46d5-8d1c-53212aade5b5",
    "customerHashId": "857dc08e-dffa-4e9a-ad96-79041c8a7025",
    "clientId": "NIM1622197836971",
    "caseId": "a9ec3c55-f06d-4f0b-9f67-e89968b861bf",
    "newClientName": "Onboarding",
    "complianceStatus": "RFI_REQUESTED",
    "status": "Pending",
    "template": "CARD_CLIENT_KYB_STATUS_WEBHOOK"
}'

example webhook when application is Approved

curl --location --request POST 'https://<customerHost:Port>/webhook' \
-H 'content-type: application/json' \
-d '{
    "clientHashId": "86ce8d7b-f3fa-46d5-8d1c-53212aade5b5",
    "customerHashId": "857dc08e-dffa-4e9a-ad96-79041c8a7025",
    "clientId": "NIM1622197836971",
    "caseId": "a9ec3c55-f06d-4f0b-9f67-e89968b861bf",
    "newClientName": "Onboarding",
    "complianceStatus": "COMPLETED",
    "status": "Clear",
    "template": "CARD_CLIENT_KYB_STATUS_WEBHOOK"
}'

Request body

Field	Description	Type
clientHashId	This is the clientHashId of the parent client.	UUID
customerHashId	This field contains the unique customer identifier generated at the time of customer creation.	UUID
clientId	This field contains the internal client ID for KYB.	UUID
caseId	This field contains the compliance case ID of the customer.	String
newClientName	This field contains the name of the new client which has been onboarded.	String
complianceStatus	This field contains the compliance status of the new client undergoing KYB. The possible values are: \n \n• INITIATED \n• IN_PROGRESS \n• ACTION_REQUIRED \n• RFI_REQUESTED \n• RFI_RESPONDED \n• COMPLETED \n• REJECT \n• ERROR \n• EXPIRED \n• CLOSED	String
status	This field contains the status of the customer. The possible values are: \n• Pending \n• Clear \n• Failed	String
template	The value for this field is CARD_CLIENT_KYB_STATUS_WEBHOOK.	String