API REFERENCE
证件 OCR 查询接口
原始 PDF识别菲律宾或墨西哥证件图片,返回证件号码、姓名及生日等结构化字段。支持直接传 Base64,或先上传图片后传 fileNo。
POST
拉美地区
http://mxg.mnemodata.com/gateway/juan/idOcr东南亚地区
http://ph.mnemodata.com/gateway/juan/idOcr输入参数列表
| 参数名 | 类型 | 说明 |
|---|---|---|
| member | String | 商户号 接口平台开通的商户号 |
| terminal | String | 终端号 接口平台开通的终端号 |
| sign | String | 加密参数 对业务参数加密后的字符串,详见 signData 说明 |
signData 加密参数
以下参数需在客户端按约定加密算法加密后,作为 signData 字段的值传入。
| 参数名 | 类型 | 说明 |
|---|---|---|
| member | String | 商户号 接口平台开通的商户号 |
| terminal | String | 终端号 接口平台开通的终端号 |
| member | String | 商户订单号 最大 50 位且每次不能重复;该字段是双方订单核实的唯一字段,需保存 |
| sub | String | 直接授权商户名称 需为与查询用户直接签订授权协议的公司主体的工商登记名称 |
| id | String | 证件类型 DRIVINGLICENSE(Driver's License)| NATIONALID(National ID)| PAGIBIG(Pag-IBIG)| PASSPORT(Passport)| HEALTHCARD(Philhealth Card)| POSTALID(Postal ID)| PRC(PRC ID)| SSS(SSS Card)| TIN | UMID | VOTERID(Voter's ID) |
| param | String | 图片参数类型 base64:图片字节数组的 Base64 字符串;url:图片上传接口返回的 fileNo |
| image | String | 图片类型 支持 jpg、jpeg、png、bmp |
| image必填 | String | 图片 paramType=url 时传 fileNo;paramType=base64 时传图片 Base64,建议短边大于 480px |
返回参数列表
| 参数名 | 类型 | 说明 |
|---|---|---|
| success | boolean | 请求成功标识 true: 请求成功;false: 请求失败 |
| error | String | 状态码 详见公共状态码,success 为 true 时返回 null |
| error | String | 状态描述 详见公共状态码,success 为 true 时返回 null |
| data | Object | 结果数据 包含交易结果及业务详情 |
data 字段说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | String | 交易结果编码 业务状态码,详见各接口 code 状态表 |
| trade | String | 交易订单号 系统生成的本次交易唯一流水号 |
| desc | String | 交易结果描述 对 code 的文字说明 |
| fee | String | 收费标识 Y: 本次查询计费;N: 本次查询不计费 |
| detail | Object | 业务详情 具体筛查结果,字段因接口而异,详见各接口 detail 说明 |
detail 筛查结果字段
| 参数名 | 类型 | 说明 |
|---|---|---|
| id | String | 证件类型 识别使用的证件类型 |
| id | String | 证件号码 |
| first | String | First Name UMID、PASSPORT、PRC、VOTERID、NATIONALID 时返回 |
| middle | String | Middle Name UMID、PASSPORT、PRC、VOTERID、NATIONALID 时返回 |
| last | String | Last Name UMID、PASSPORT、PRC、VOTERID、NATIONALID 时返回 |
| full | String | Full Name TIN、DRIVINGLICENSE、HEALTHCARD、SSS、POSTALID、PAGIBIG 时返回 |
| birth | String | 生日(识别原文) 部分证件类型返回 |
| birth | String | 生日(标准格式) 格式:YYYY-MM-DD |
code 验证状态表
| code | 收费 | 描述 |
|---|---|---|
| 0 | 计费 | 成功 |
| 1 | 免费 | 查无结果 |
| 999 | 免费 | 渠道异常 |