一、2331-SDK活体验证V3授权接口

1. 接口功能

根据姓名、身份证号、移动端APP采集信息,验证操作人真实性。SDK活体验证V3版本共三步。首先根据数据平台提供的V3版本SDK操作手册将SDK集成到APP中,通过2331-SDK活体验证V3授权接口获取BizToken并初始化SDK进行活体采集。第二步将采集到的信息通过3201-文件批量上传到服务器。第三步在发送2332-SDK活体验证V3验证接口进行验证。详细过程如下:

首先,用户在移动端APP触发活体,机构方服务端调用2331授权接口获取BizToken(BizToken唯一且仅能使用一次,有效期为1小时),使用BizToken初始化已经集成在APP中的SDK进行活体采集,用户操作完成后SDK返回活体采集信息--加密字符串(base64)。

第二步,机构方服务端需要将上一步获取到加密字符串(要保证数据传输过程中内容不变)通过3201文件上传接口上传给平台(文件名称命名为XXX.data),得到返回的1个fileID。

最后,将2331授权接口返回的BizToken和3201接口返回的fileid通过2332验证接口发送给平台以获取活体验证结果。

2. 报文结构

​ 请求报文:

报文元素 出现要求 数据类型 数据格式 说明
TxCode R NOT NULL N1..4 交易类型
InstitutionID R NOT NULL ANS1..8 机构编号
TxSN R NOT NULL ANS1..32 交易流水号
Name R NOT NULL ANS1..150 姓名
IdentificationNumber
R NOT NULL ANS1..80 身份证件号码
Threshold O ANS2 档位,为空时,默认T5:
T3
T4
T5
T6
LivenessType O N2 验证类型:
10-动作活体,
20-静默活体
30-炫彩活体  (默认为30)
Remark O ANS0..256 备注,1:BizToken获取失败;其他:BizToken获取成功

​ 响应报文:

报文元素 出现要求 数据类型 数据格式 说明
Code R NOT NULL N1..6 响应代码
Message R NOT NULL ANS1..256 响应消息
TxCode C NOT NULL ANS1..4 交易类型
InstitutionID C NOT NULL ANS1..8 机构编号
TxSN C NOT NULL ANS1..32 交易流水号
TraceNo C NOT NULL ANS1..32 系统跟踪号
ResponseCode C NOT NULL N0..4 通道响应代码
ResponseMessage C NOT NULL ANS0..256 通道响应消息
Status C N2 状态:
20-获取成功
30-获取失败
BizToken C ANS1..256 BizToken值

二、3201-小文件批量上传

1. 接口功能

​ 批量上传小文件,单个文件大小不超过2M,文件数量不超过5个。文件名称命名为.data(仅支持SDK V3版本)。文件存储ID(FileID)对应需调用3201的其他接口中的上传照片ID(UploadFileID)。

2. 报文结构

​ 请求报文:

报文元素 出现要求 非空约束 数据格式 说明
TxCode R NOT NULL N1..4 交易类型
InstitutionID R NOT NULL ANS1..8 机构编号
TxSN R NOT NULL ANS1..32 交易流水号
Files FileName R NOT NULL ANS1..256 文件名称
例如: XXX.data
FileContent R NOT NULL ANS1.. 文件内容 Base64
Remark O ANS0..256 备注

​ 响应报文:

报文元素 出现要求 非空约束 数据格式 说明
Code R NOT NULL N1..6 响应代码
Message R NOT NULL ANS1..256 响应消息
TxCode C ANS1..4 交易类型
InstitutionID C ANS1..8 机构号
TxSN C ANS1..32 交易流水号
TraceNo C ANS1..32 系统跟踪号
Files FileName C ANS1..256 文件名称
FileID C ANS1..32 文件存储ID

三、2332-SDK活体验证V3验证

1. 接口功能

​ SDK活体验证接口获取活体验证结果。

2. 报文结构

​ 请求报文:

报文元素 出现要求 数据类型 数据格式 说明
TxCode R NOT NULL N1..4 交易类型
InstitutionID R NOT NULL ANS1..8 机构编号
TxSN R NOT NULL ANS1..32 交易流水号
BizToken R NOT NULL ANS1..256 BizToken值(调用2331接口返回的bizToken)
UploadFileID R NOT NULL ANS1..64 人脸文件ID(先通过接口3201上传文件,获取文件ID)
ReturnImage O N1 是否返照片,不出现时,默认不返照片
0-不返
1-返照片
Remark O String ANS0..256 备注

​ 响应报文:

报文元素 出现要求 数据类型 数据格式 说明
Code R NOT NULL N1..6 响应代码
Message R NOT NULL ANS1..256 响应消息
TxCode C NOT NULL ANS1..4 交易类型
InstitutionID C NOT NULL ANS1..8 机构编号
TxSN C NOT NULL ANS1..32 交易流水号
TraceNo C NOT NULL ANS1..32 系统跟踪号
ResponseCode C NOT NULL N0..4 通道响应代码
ResponseMessage C NOT NULL ANS0..256 通道响应消息
Verification C N2 验证状态:
20=匹配
30=不匹配
Image C clob 采集照片,Base64编码
VideoKey C ANS0..256 解密密钥,用于获取SDK端保存的视频及图片
VerificationScore C NOT NULL ANS0..8 人脸验证得分
VerifyThreshold T3 C NOT NULL ANS0..8 风险为千分之一的验证门槛
T4 C NOT NULL ANS0..8 风险为万分之一的验证门槛
T5 C NOT NULL ANS0..8 风险为十万分之一的验证门槛(T5为默认验证标准)
T6 C NOT NULL ANS0..8 风险为百万分之一的验证门槛

四、报文样例

[!TIP] (测试数据不校验数据真实性,默认为验证结果为匹配,若验证其他结果,可查看“总体规范-6.1.2.4 Remark 备注”)

1.2231报文样例

请求报文(InstitutionID由中金分配):

{
    "TxCode":"2331",
    "IdentificationNumber":"110101198001010037",
    "InstitutionID":"XXXXXX",
    "TxSN":"202404241539057642120283283",
    "LivenessType":"30",
    "Remark":"",
    "Threshold":"T5",
    "Name":"小王"
}

响应报文:

{
    "Status":"20",
    "ResponseCode":"1000",
    "TxCode":"2331",
    "Message":"SUCCESS",
    "InstitutionID":"XXXXXX",
    "BizToken":"1713944376,81770a43-c935-4eb9-a11e-7a2f6df5c776",
    "TxSN":"202404241539057642120283283",
    "ResponseMessage":"查询成功",
    "Code":"2000",
    "TraceNo":"2404241539360251112012098"
}

2.3201报文样例

​ 3201-文件上传接口请求地址与活体验证类接口不同,需注意接口地址,具体可查看交易地址

请求报文:

{
    "TxCode":"3201",
    "InstitutionID":"XXXXXX",
    "TxSN":"202404241541456395884017698",
    "Files":[
        {
            "FileContent":"M3gwMlYzMW......ZhdEFJZA==",
            "FileName":"ceshi.data"
        }
    ],
    "Remark":""
}

响应报文:

{
    "TxCode":"3201",
    "Message":"SUCCESS",
    "InstitutionID":"XXXXXX",
    "TxSN":"202404241541456395884017698",
    "Files":[
        {
            "FileName":"ceshi.data",
            "FileID":"2404241542591901203454316"
        }
    ],
    "Code":"2000",
    "TraceNo":"2404241542591361312016427"
}

3.2332报文样例

请求报文:

{
    "ReturnImage":"0",
    "TxCode":"2332",
    "InstitutionID":"XXXXXX",
    "TxSN":"202404241543219416538422283",
    "BizToken":"1713944376,81770a43-c935-4eb9-a11e-7a2f6df5c776",
    "UploadFileID":"2404241542591901203454316",
    "Remark":""
}

响应报文:

{
    "VerificationScore":"80",
    "ResponseCode":"0000",
    "TxCode":"2332",
    "Message":"SUCCESS",
    "InstitutionID":"XXXXXX",
    "VerifyThreshold":{
        "T4":"69.315",
        "T5":"74.399",
        "T6":"78.038",
        "T3":"62.169"
    },
    "TxSN":"202404241543219416538422283",
    "Verification":"20",
    "ResponseMessage":"匹配",
    "Code":"2000",
    "VideoKey":"0ec608c4",
    "TraceNo":"2404241543533571112016996"
}

该文档未解决您的疑问?png 查看常见问题

Copyright © China Financial Digital Technology Co., Ltd. all right reserved,powered by Gitbook该文章修订时间: 2024-08-08 14:26:41

results matching ""

    No results matching ""