东信EST-M20手持人证合一平台接口协议V0.0.2
目 录
1. 简介
1.1. Https方式接入
第三方系统与人证合一平台通过Http Post方式进行数据交互。
本协议涉及到的中文均采用UTF-8编码格式，为了显示美观数据样本手工加入折行。
1.2. 面向的读者
《人证合一平台接口协议》文档是面向具备一定的http开发经验的开发者。
1.3. 返回数据
该平台提供的接口返回数据为json。
2. 协议定义
2.1. 上传人证比对记录
2.1.1. 描述
人证合一客户端将比对记录上传到平台，平台保存比对记录用于后续操作。
2.1.2. 接口定义
https://ip:port/fvms/api/uploadCmpRecord
2.1.3. 输入参数
参数名称 | 类型 | 必填 | 参数说明 | 备注 |
deviceNo | String(1,64) | Y | 设备号 | |
name | String(1,32) | Y | 姓名 | |
cardno | String(1,18) | Y | 身份证号码 | |
cardImg | String | Y | 身份证照base64数据 | |
spotImg | String | Y | 现场照base64数据 | |
score | smallint (3) | Y | 对比分数 | |
threshold | smallint (3) | Y | 阈值 | |
validateType
| smallint (1) | Y | 验证模式(1：只验人脸 2：人脸或指纹任意通过 3：人脸、指纹同时通过) | |
faceResult | smallint (1) | Y | 人脸比对结果（1：成功 2：失败 3：未检测到人脸） | |
fingerResult | smallint (1) | Y | 指纹比对结果（1：成功 2：失败 3：未检测到指纹 4.指纹不检 | 只验证人脸 4 |
fingerNum | String(3) | Y | 指纹现场比对次数(-,0/1 1/1) | 只验证人脸 - |
result | smallint (1) | Y | 最终结果（1：成功 2：失败 3：未检测到人脸 4：未检测到指纹 ） | |
folk | String(30) | Y | 民族 | |
sex | smallint (1) | Y | 性别（1：男 2：女 3：未知） | |
birthday | String(10) | Y | 生日 | |
address | String(1,255) | Y | 家庭地址 | |
validdate1 | String(1,16) | Y | 身份证开始有效期 | |
validdate2 | String(1,16) | Y | 身份证结束有效期 | |
authority | String(1,128) | Y | 签发机关 | |
compareDate | long | Y | 比对时间 |
请求样例：
requestData="{"address":"重庆市渝中区龙华大道","authority":"重庆市渝中区公安局","birthday":"1999-03-02","cardImg":"/9j/4AAQSkZJRgAB…"
,"spotImg":"/9j/4AAQSkZJRgAB…","threshold":80,"validateType":1,"validdate1":"2001-05-10","validdate2":"2020-05-10"}"
2.1.4. 输出参数
返回值名称 | 类型 | 必填 | 参数说明 | 备注 |
code | int | Y | 返回码，0成功，非0失败 | |
msg | String(1,128) | N | 返回码描述 |
返回样例：
{"code":0,"msg":"成功"}
