检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
SDK简介 人证核身服务端SDK是对人证核身提供的REST API进行的封装,您可以直接继承服务端从而实现对人证核身服务的快速操作。 接口与API对应关系 表1 接口与API对应关系 接口 API 人证核身标准版(三要素) POST https://{endpoint}/v2.0/ivs-standard
Failed 未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大,服务器无法处理,因此拒绝请求。为防止客户端的连续请求,服务器可能会关闭连接。如果只是服务器暂时无法处理,则会包含一个Retry-After的响应信息。
查看API使用次数 登录人证核身服务控制台。 在“云上服务管理”页面,查看API的使用量和套餐包的使用量。 图1 API使用量统计 父主题: API使用类
约束与限制 只支持“华北-北京四”区域。 只支持中国大陆身份证的识别。 支持港澳台居住证核验,证件信息需文本输入 只支持JPG格式,图片中人像需无遮挡。 图像数据,base64编码,要求base64编码后大小不超过4MB。 图像各边的像素大小在300到8000px之间。 图像中身
什么是人证核身 人证核身服务(Identity Verification Solution,简称IVS),是指通过用户的身份证信息、人脸图片,与权威数据库进行比对,进而实现身份验证。 当前,人证核身提供以下子功能: 标准版(三要素) 使用姓名、身份证号码、人脸图像三要素进行匹配核验。
统计API使用量 IVS服务控制台支持查看API的总调用量、调用成功量、调用失败量。 如果您购买了套餐包,可在“套餐包管理”页面,查看已有的套餐包及使用详情。套餐包费用扣减规则请参见“产品介绍 > 计费说明”。
https://{endpoint}/v3/projects”,其中“{endpoint}”为IAM的终端节点。接口的认证鉴权请参见认证鉴权。 响应示例如下,例如,人证核身服务部署的区域为“cn-north-4”,响应消息体中查找“name”为“cn-north-4”,其中“projects”下的“id”即为项目ID。
HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。 HEAD 请求服务器资源头部。 PATCH
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组数字代码,状态码表示了请求响应的状态,如果调用后返回状态码为2xx,则表示调用成功。完整的状态码列表请参见状态码。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。例如表1所示。
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID(domain-id),所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 单击用户名,在下拉列表中单击“我的凭证”。 在“我的凭证”页面的项目列表中查看账号ID。 图1 查看账号ID 父主题:
约束与限制 只支持“华北-北京四”区域。 只支持中国大陆身份证的识别。 只支持JPG格式,图片中人像需无遮挡。 图像数据,base64编码,要求base64编码后大小不超过4MB。 图像各边的像素大小在300到8000px之间。 图像中身份证区域有效占比超过15%,保证整张身份证内容及其边缘包含在图像内。
调用说明 人证核身提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 父主题: 使用前必读
终端节点即调用API的请求地址,不同服务不同区域的终端节点不同,您可以从地区和终端节点中查询所有服务的终端节点。 人证核身的终端节点如表1所示,请您根据业务需要选择对应区域的终端节点。 表1 人证核身的终端节点 区域名称 区域 终端节点(Endpoint) 部署服务 华北-北京四 cn-north-4
校验信息说明 表1 验证信息 检验代码 检验结果 检验信息 说明 1000 valid Successful certification 认证成功。 2001 invalid Inconsistent identity information 认证信息不一致,即姓名与身份证号码不一致。
步骤3:获取示例代码 步骤4:调用服务 准备工作前提条件 账号完成实名认证,且不能处于欠费或冻结状态。 步骤1:开通服务 登录人证核身服务控制台。 选择需要使用的服务,在操作列单击“开通服务”。本示例中开通人证核身证件版(二要素)API。 图1 开通服务 服务开通成功后,开通状态显示“已开通”。
IdcardResult 身份证图像文字识别结果结构体。 表1 结构体说明 参数 类型 描述 name String 身份证上识别的名称。 number String 身份证号。 sex String 性别。 birth String 出生日期。 ethnicity String
准备工作 开通人证核身服务 登录人证核身控制台。 在控制台左上角选择区域为“北京四”,并开通“人证核身标准版(三要素)”。 开通后,默认为按需计费。 图1 开通“人证核身标准版(三要素)” 开通人脸识别服务 登录人脸识别控制台。 在控制台左上角选择区域为“北京四”,并开通“动作活体检测”。
接口的并发是多少 人证核身标准版(三要素)、人证核身证件版(二要素)默认并发为10qps。 父主题: API使用类
问题现象 调用人证核身接口时,报错“IVS.0015”。 该报错表示调用的API没有开通。 解决方法 请先登录控制台开通所需的服务。 如已开通,检查开通服务区域和实际调用的API的区域是否一致。 图1 检查区域信息 父主题: 错误码类
快速卸载 在进行一键卸载之前,需要先删除该方案创建的委托。 删除委托 登录统一身份认证服务(IAM)控制台。 进入“委托”页面,删除委托。 图1 删除委托 一键卸载 登录人证核身解决方案部署页面。 单击方案堆栈后的“删除”。 图2 一键卸载 在弹出的删除堆栈确认框中,输入方案的堆