简介
认证产品接口文档说明与接入指引,新接入必读。
文档说明
本文档为认证产品接口文档,涵盖 OCR、工商、银行卡、实名、运营商等开放能力。供商户系统对接与联调使用。
服务地址
| 环境 | Base URL | 说明 |
|---|---|---|
| 生产 | 由服务方提供 | 正式环境请求地址 |
| 测试 | 由服务方提供 | 联调环境请求地址 |
目录结构
| 分类 | 接口 |
|---|---|
| OCR | 营业执照 OCR、银行卡 OCR、身份证 OCR |
| 工商 | 二要素、四要素详版、四要素简版 |
| 银行卡 | 二三四要素-身份证、二三四要素-非身份证、账户类型查询比对、账户类型查询 |
| 实名 | 公安实名二要素、身份证人脸比对 |
| 运营商 | 运营商三要素 |
快速开始
1. 申请接入参数
向服务方申请以下信息,并一并提供对账账单接收邮箱(详见对账说明):
| 参数 | 说明 |
|---|---|
parMerCode | 主商户号 |
merAcct | 商户账号 |
appKey | 加签密钥 |
2. 配置出口 IP 白名单(必做)
未加白名单无法调通
接口不是无条件开放调用的。交易请求须来自服务方已登记的出口 IP,否则服务端会拒绝连接,客户端表现为 HTTP POST 超时。测试环境与生产环境均须配置白名单。
完成接口开发后,请联系运营,提供贵司发起交易的出口公网 IP(测试、生产可一并提前提供)。白名单生效后才可正常发通交易。
如何查看本机 / 服务器出口 IP
出口 IP 指请求到达公网时对外呈现的地址(经 NAT / 网关后的公网出口),不是内网地址(如 192.168.x.x、10.x.x.x)。请务必在实际发起交易的机器、容器或所在出口网络上查询;开发机、办公网查到的 IP,往往与服务器真实出口不一致。
国内与海外访问的探测站点可用性不同,请按环境选用;建议优先取 IPv4(命令可加 -4),并至少用两种方式交叉确认结果一致后再提交白名单。
国内网络(推荐)
| 方式 | 示例 |
|---|---|
| 浏览器 | 打开 https://www.cip.cc 或 https://myip.ipip.net |
| Linux / macOS | curl -4 -s cip.cc 或 curl -4 -s myip.ipip.net(只要纯 IP 可用 curl -4 -s ip.cip.cc) |
| Windows | 浏览器访问上述站点;若已安装 curl:curl -4 -s cip.cc |
海外 / 国际网络(推荐)
| 方式 | 示例 |
|---|---|
| 浏览器 | 打开 https://ifconfig.me 或 https://icanhazip.com |
| Linux / macOS | curl -4 -s https://ifconfig.me 或 curl -4 -s https://api.ipify.org |
| Windows PowerShell | (Invoke-RestMethod https://api.ipify.org).ToString() |
常见误区
- 云主机控制台里的「公网 IP / EIP」未必等于业务实际出口:经 NAT 网关、共享带宽、代理出网时,应以探测站点返回结果为准。
- 多机房、多链路、弹性伸缩场景下,出口可能不唯一或会变化,请提交全部固定出口,或在变更前联系运营更新白名单。
- 国内访问
ifconfig.me、ip.sb等海外站点可能超时或结果异常,请改用上方国内推荐方式。
提供白名单时请注意
- 若测试与生产出口不同,请分别提供两套 IP;若相同,说明即可。
- 请提供 IPv4 公网地址;若仅有 IPv6,请与运营确认是否支持。
3. 联调测试
- 阅读通用约定,了解报文格式与加签规则。
- 按本文档与各接口页中的代码示例完成开发。
- 确认测试出口 IP 已加入白名单后发起联调。
测试环境行为
- 测试环境在白名单生效后可正常连通;未加白名单时 POST 会超时。
- 测试环境固定返回成功;实名类接口固定返回一致(便于联调,不代表生产真实核验结果)。
4. 上线切换
| 项 | 说明 |
|---|---|
| 接口地址 / 参数 | 生产与测试相同,无需因上线修改交易 URL 或加签逻辑 |
| 代码 | 无需改代码 |
| 白名单 | 须提前将生产出口 IP加入白名单(可在测试阶段一并提交) |
| 切换方式 | 通知服务方做环境切换后,同一地址即按生产规则真实返回 |
上线检查清单
- 生产出口 IP 已提交并确认白名单生效
- 对账邮箱已预留且可正常收信
- 已按业务选择接口,并用
productType区分产品 - 已对照各接口附录返回码确认计费规则
- 已通知服务方完成测试 → 生产切换