注册回调通知【webhook】
简要描述
注册完成后,会以 JSON 的形式将相关 KYC 结果和用户信息发送给商户。商户需要接收并处理这些通知,并按照文档规范返回应答。相同的通知可能会多次发送给商户,商户必须能够正确处理重复的通知。通知的频率为:在 10 分钟内订单每 10 秒请求一次,1 小时内订单每 5 分钟请求一次,48 小时内订单每小时请求一次。
回调参数
| 参数名 | 验签 | 必选 | 类型 | 长度 | 说明 |
|---|---|---|---|---|---|
| userNo | 是 | 是 | string | 32 | 用户编号 |
| 是 | 是 | string | 128 | 邮箱 | |
| kycLevel | 是 | 是 | int | 3 | kyc等级 |
| kycType | 是 | 是 | string | 32 | kyc类型 |
| kycStatus | 是 | 是 | int | 3 | kyc状态(1:成功 2:永久拒绝 3:临时拒绝) |
| firstName | 是 | 是 | string | 16 | firstName |
| lastName | 是 | 是 | string | 32 | lastName |
| country | 是 | 否 | string | 256 | 国家 |
| idDocType | 是 | 是 | string | 256 | 证件类型 |
| dob | 否 | 是 | string | 512 | 出生日期 |
| validUntil | 是 | 是 | String | 10 | 有效期 |
| number | 否 | 否 | string | 256 | 号码 |
| gender | 是 | 是 | string | 512 | 性别 |
| additionalNumber | 是 | 是 | string | 512 | 附加号码 |
| callbackUrl | 是 | 是 | string | 512 | 回调url |
| redirectUrl | 是 | 是 | string | 512 | 通知url |
| documentPhoto | 是 | 是 | string | 512 | 正面照片 |
| documentBackPhoto | 是 | 是 | string | 512 | 反面照片 |
| facePhoto | 是 | 是 | string | 512 | 脸部照片 |
| kycFailJson | 是 | 是 | string | 512 | 失败json |
| street | 是 | 是 | string | 512 | 街道 |
| city | 是 | 是 | string | 512 | 城市 |
| state | 是 | 是 | string | 512 | 州 |
| zipCode | 是 | 是 | string | 512 | 邮编 |
| address | 是 | 是 | string | 512 | 地址 |
| userNum | 是 | 是 | string | 512 | 用户中心用户编号 |
| merchantNo | 是 | 是 | string | 512 | 商户号 |
| subMerchantNo | 是 | 是 | string | 512 | 子商户号 |
| remark | 是 | 是 | string | 512 | 备注 |
示例
{
"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"
}
商户响应
商户处理后http的code=200,不再回调;code!=200,会定期发送数据。
Updated 10 months ago