注册回调通知【webhook】

简要描述

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

回调参数

参数名验签必选类型长度说明
userNostring32用户编号
emailstring128邮箱
kycLevelint3kyc等级
kycTypestring32kyc类型
kycStatusint3kyc状态(1:成功 2:永久拒绝 3:临时拒绝)
firstNamestring16firstName
lastNamestring32lastName
countrystring256国家
idDocTypestring256证件类型
dobstring512出生日期
validUntilString10有效期
numberstring256号码
genderstring512性别
additionalNumberstring512附加号码
callbackUrlstring512回调url
redirectUrlstring512通知url
documentPhotostring512正面照片
documentBackPhotostring512反面照片
facePhotostring512脸部照片
kycFailJsonstring512失败json
streetstring512街道
citystring512城市
statestring512
zipCodestring512邮编
addressstring512地址
userNumstring512用户中心用户编号
merchantNostring512商户号
subMerchantNostring512子商户号
remarkstring512备注

示例

{
    "amlReport":"https://sumsub-kyc.oss-cn-hongkong.aliyuncs.com/6cf2-b773-8ce7128ee11e.pdf",
    "callbackUrl":"https://api-test.alchemytech.cc/webhooks/kyc/notify",
    "country":"CHN",
    "dob":"1988-02-10",
    "documentBackPhoto":"https://sumsub-kyc.oss-cn-hongkong.aliyuncs.com/onfido-kyc/109fb33e/back.png",
    "documentPhoto":"https://sumsub-kyc.oss-cn-hongkong.aliyuncs.com/onfido-kyc/109fbc3e/front.png",
    "email":"[email protected]",
    "facePhoto":"https://sumsub-kyc.oss-cn-hongkong.aliyuncs.com/onfido-kyc/109fb3dc3e/face.png",
    "firstName":"Test",
    "gender":"2",
    "idDocType":"1",
    "idvReport":"https://sumsub-kyc.oss-cn-hongkong.aliyuncs.com/6cf2e.pdf",
    "kycFailJson":"[]",
    "kycLevel":1,
    "kycPlatform":"onfido",
    "kycStatus":1,
    "kycType":"1",
    "lastName":"last name",
    "merchantNo":"TEST000001",
    "number":"232301198802103743",
    "subMerchantNo":"MER10123012",
    "userNo":"3db9dbe7ecd542b98f1728e4617db96f",
    "userNum":"101016958103533043054",
    "validUntil":"2037-02-10",
    "remark":"123"
}

商户响应

商户处理后http的code=200,不再回调;code!=200,会定期发送数据。