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

accept:想要接收怎样格式的响应结果,这里填写为application/json,即 JSON 格式。authorization:调用 API 的密钥,申请之后可以直接下拉选择。
image_url:需要处理的身份证图片链接。config:可选配置项,布尔值字段,默认都为 false,支持copy_warn、border_check_warn、reshoot_warn、detect_ps_warn、temp_id_warn、quality(阈值 0-100)。

sim,相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)result,业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分。description,此处姓名与身份证号码验证的结果。name,身份证中的姓名信息,如果没有上传身份证图片则是空的。sex,身份证中的性别信息,如果没有上传身份证图片则是空的。nation,身份证中的民族信息,如果没有上传身份证图片则是空的。birth,身份证中的生日信息,如果没有上传身份证图片则是空的。address,身份证中的家庭住址信息,如果没有上传身份证图片则是空的。id_num,身份证中的身份证号码信息,如果没有上传身份证图片则是空的。portrait,身份证头像照片的base64编码,如果抠图失败会拿整张身份证做比对并返回空。warnings,告警信息,当在Config中配置了告警信息会停止人像比对,Result返回错误(FailedOperation.OcrWarningOccurred)并有此告警信息。quality,图片质量分数,当请求Config中配置图片模糊告警该参数才有意义,取值范围(0~100),目前默认阈值是50分,低于50分会触发模糊告警。encryption,敏感数据加密信息。
错误处理
在调用 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.

