Client KYB Status

This template 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

FieldDescription
Content-Typeapplication/json

Request example

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",
    "template": "CARD_CLIENT_KYB_STATUS_WEBHOOK"
}'

Request body

FieldsDescriptionType
clientHashIdThis is the clientHashId of the parent client.UUID
customerHashIdThis field contains the unique customer identifier generated at the time of customer creation.UUID
clientIdThis field contains the internal client ID for KYB.UUID
caseIdThis field contains the compliance case ID of the customer.String
newClientNameThis field contains the name of the new client which has been onboarded.String
complianceStatusThis field contains the compliance status of the new client undergoing KYB. The possible values are:

• INITIATED
• IN_PROGRESS
• ACTION_REQUIRED
• RFI_REQUESTED
• RFI_RESPONDED
• COMPLETED
• REJECT
• ERROR
• EXPIRED
• CLOSED
String
templateThe value for this field is CARD_CLIENT_KYB_STATUS_WEBHOOK.String