申请流程
要使用 API,需要先到 身份证识别及信息核验 API 对应页面申请对应的服务,进入页面之后,点击「Acquire」按钮,如图所示:
如果你尚未登录或注册,会自动跳转到登录页面邀请您来注册和登录,登录注册之后会自动返回当前页面。
在首次申请时会有免费额度赠送,可以免费使用该 API。
基本使用
首先先了解下基本的使用方式,就是输入身份证图片链接,便可获得处理后验证结果,首先需要简单地传递一个image_url 字段,我们接下来就可以在界面上填写对应的内容,如图所示:

accept:想要接收怎样格式的响应结果,这里填写为application/json,即 JSON 格式。authorization:调用 API 的密钥,申请之后可以直接下拉选择。
image_url:需要处理的身份证图片链接。encryption:可选,敏感字段加密参数(如需上送密文)。

result,认证结果码,收费情况如下。- 收费结果码:
- 0: 姓名和身份证号一致
- -1: 姓名和身份证号不一致
- 不收费结果码:
- -2: 非法身份证号(长度、校验位等不正确)
- -3: 非法姓名(长度、格式等不正确)
- -4: 证件库服务异常
- -5: 证件库中无此身份证记录
- -6: 权威比对系统升级中,请稍后再试
- -7: 认证次数超过当日限制。
- 收费结果码:
description,此处姓名与身份证号码验证的结果。name,身份证中的姓名信息,如果没有上传身份证图片则是空的。id_card,身份证中的身份证号码信息,如果没有上传身份证图片则是空的。sex,身份证中的性别信息,如果没有上传身份证图片则是空的。nation,身份证中的民族信息,如果没有上传身份证图片则是空的。birth,身份证中的生日信息,如果没有上传身份证图片则是空的。address,身份证中的家庭住址信息,如果没有上传身份证图片则是空的。
自定义信息验证
我们也提供了一种不泄露身份证图片信息的方式来验证,可以只传入姓名name 和 身份证号码 id_card 来进行校验姓名和身份证号的真实性和一致性,下面是填的具体信息:

错误处理
在调用 API 时,如果遇到错误,API 会返回相应的错误代码和信息。例如:400 token_mismatched:Bad request, possibly due to missing or invalid parameters.400 api_not_implemented:Bad request, possibly due to missing or invalid parameters.401 invalid_token:Unauthorized, invalid or missing authorization token.429 too_many_requests:Too many requests, you have exceeded the rate limit.500 api_error:Internal server error, something went wrong on the server.

