Skip to main content

Customer Status

This event is triggered when the status and/or substatus of a customer is updated. Applicable for customers onboarded using Customer Onboarding v5.

https://<customerHost:Port>/webhook
FieldDescription
Content-Typeapplication/json

Request example

curl --location --request POST 'https://<customerHost:Port>/webhook' \
-H 'content-type: application/json' \
-d '{
"customerHashId": "5993e016-21b1-4c8f-9282-e5491546c47a",
"template": "CUSTOMER_STATUS_WEBHOOK",
"customerType": "INDIVIDUAL",
"walletHashIds": [
"70adc339-5b3f-4711-ad82-39ed6420bd62"
],
"externalId": "c3a2c77a-f451-4e4d-a212-48283dec4eac",
"isResubmissionAllowed": "true",
"subStatus": "",
"clientHashId": "b23b124c-9cc8-4550-b66f-ed8250ff8a5e",
"status": "rejected",
"tags": [
{
"value": "value",
"key": "key"
}
]
}'

Request body

FieldDescriptionType
clientHashIdThe clientHashId of the parent client.UUID
customerHashIdTh the unique customer identifier generated at the time of customer creation.UUID
customerTypeThe type of the customer.String
externalIdClient-created unique ID.String
isResubmissionAllowedDetails if the customer can be resubmitted for onboardingString
statusThe status of the customer. Available values include:
  • pending
  • clear
  • failed
String
subStatusThe substatus of the application. Details the next steps to take to onboard the application.String
customerTypeThis field contains the type of the customer. It should be INDIVIDUAL for individual customer.String
tagsCustom tags & values applied by the client when the customer was initially onboarded. Maximum 15 key-value pairs can be sent in tags.Array
templateThe value for this field is CUSTOMER_STATUS_WEBHOOK.String
walletHashIdsThe unique identifier of the customer’s wallet linked to the transaction.String