Registration Callback Notification [Webhook]

Brief Description

After registration is completed, the KYC results and user information will be sent to the merchant in JSON format. The merchant needs to receive and process these notifications and respond according to the document specifications. The same notification may be sent to the merchant multiple times, and the merchant must be able to handle duplicate notifications correctly. The frequency of notifications is as follows: for orders within 10 minutes, a request is made every 10 seconds; for orders within 1 hour, a request is made every 5 minutes; for orders within 48 hours, a request is made every hour.

Callback Parameters

Parameter Name	Signature Verification	Required	Type	Length	Description
userNo	Yes	Yes	string	32	User number
email	Yes	Yes	string	128	Email
kycLevel	Yes	Yes	int	3	KYC level
kycType	Yes	Yes	string	32	KYC type
kycStatus	Yes	Yes	int	3	KYC status (1: Success, 2: Permanent rejection, 3: Temporary rejection)
firstName	Yes	Yes	string	16	First name
lastName	Yes	Yes	string	32	Last name
country	Yes	No	string	256	Country
idDocType	Yes	Yes	string	256	ID document type
dob	No	Yes	string	512	Date of birth
validUntil	Yes	Yes	String	10	Valid until
number	No	No	string	256	Number
gender	Yes	Yes	string	512	Gender
additionalNumber	Yes	Yes	string	512	Additional number
callbackUrl	Yes	Yes	string	512	Callback URL
redirectUrl	Yes	Yes	string	512	Notification URL
documentPhoto	Yes	Yes	string	512	Document front photo
documentBackPhoto	Yes	Yes	string	512	Document back photo
facePhoto	Yes	Yes	string	512	Face photo
kycFailJson	Yes	Yes	string	512	Failed JSON
street	Yes	Yes	string	512	Street
city	Yes	Yes	string	512	City
state	Yes	Yes	string	512	State
zipCode	Yes	Yes	string	512	Zip code
address	Yes	Yes	string	512	Address
userNum	Yes	Yes	string	512	User center user number
merchantNo	Yes	Yes	string	512	Merchant number
subMerchantNo	Yes	Yes	string	512	Sub-merchant number
remark	Yes	Yes	string	512	Remark

Example

{
    "amlReport":"https://sumsub-kyc.oss***.pdf",
    "callbackUrl":"https://****/webhooks/kyc/notify",
    "country":"CHN",
    "dob":"1988-02-10",
    "documentBackPhoto":"https://sumsub-kyc.oss***.png",
    "documentPhoto":"https://sumsub-kyc.oss***.png",
    "email":"[email protected]",
    "facePhoto":"https://sumsub-kyc.oss***.png",
    "firstName":"Test",
    "gender":"2",
    "idDocType":"1",
    "idvReport":"https://sumsub-kyc.oss***.pdf",
    "kycFailJson":"[]",
    "kycLevel":1,
    "kycPlatform":"onfido",
    "kycStatus":1,
    "kycType":"1",
    "lastName":"last name",
    "merchantNo":"TEST000001",
    "number":"***",
    "subMerchantNo":"***",
    "userNo":"***",
    "userNum":"***",
    "validUntil":"2037-02-10",
    "remark":"123"
}

Merchant Response

After processing by the merchant, if the HTTP code is 200, no further callbacks are made. If the code is not 200, data will be periodically sent.