注册回调通知【webhook】

简要描述

注册完成后,会以 JSON 的形式将相关 KYC 结果和用户信息发送给商户。商户需要接收并处理这些通知,并按照文档规范返回应答。相同的通知可能会多次发送给商户,商户必须能够正确处理重复的通知。通知的频率为:在 10 分钟内订单每 10 秒请求一次,1 小时内订单每 5 分钟请求一次,48 小时内订单每小时请求一次。

回调参数

参数名验签必选类型长度说明
userNo是是string32用户编号
email是是string128邮箱
kycLevel是是int3kyc等级
kycType是是string32kyc类型
kycStatus是是int3kyc状态(1:成功 2:永久拒绝 3:临时拒绝)
firstName是是string16firstName
lastName是是string32lastName
country是否string256国家
idDocType是是string256证件类型
dob否是string512出生日期
validUntil是是String10有效期
number否否string256号码
gender是是string512性别
additionalNumber是是string512附加号码
callbackUrl是是string512回调url
redirectUrl是是string512通知url
documentPhoto是是string512正面照片
documentBackPhoto是是string512反面照片
facePhoto是是string512脸部照片
kycFailJson是是string512失败json
street是是string512街道
city是是string512城市
state是是string512州
zipCode是是string512邮编
address是是string512地址
userNum是是string512用户中心用户编号
merchantNo是是string512商户号
subMerchantNo是是string512子商户号
remark是是string512备注

示例

{
    "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,会定期发送数据。


Did this page help you?