人证核身服务 IVS-使用身份证图片、人脸图片验证:请求参数

时间:2024-04-29 09:56:07

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

X-Auth-Token值获取方法请参见认证鉴权

Enterprise-Project-Id

String

企业项目ID。IVS支持通过企业项目管理(EPS)对不同用户组和用户的资源使用,进行分账。

获取方法:进入“企业项目管理”页面,单击企业项目名称,在企业项目详情页获取Enterprise-Project-Id(企业项目ID)。

企业项目创建步骤请参见用户指南。

说明:

说明: 创建企业项目后,在传参时,有以下三类场景。

  • 携带正确的ID,正常使用IVS服务,账单的企业项目会被分类到企业ID对应的企业项目中。
  • 携带格式正确但不存在的ID,正常使用IVS服务,账单的企业项目会显示对应不存在的企业项目ID。
  • 不携带ID或格式错误ID(包含特殊字符等),正常使用IVS服务,账单的企业项目会被分类到"default"中。
表2 请求Body参数

参数

是否必选

参数类型

描述

meta

Meta object

请求元数据,例如表征本次请求的唯一标注uuid。

data

data object

请求消息的数据部分。

表3 Meta

参数

是否必选

参数类型

描述

uuid

String

唯一标识此次请求的ID,用户自定义,不超过64位。

表4 data

参数

是否必选

参数类型

描述

req_data

Array of ReqDataByIdCardImage objects

请求列表,用于支持批量调用。目前暂时只支持单个数据查询。

表5 ReqDataByIdCardImage

参数

是否必选

参数类型

描述

idcard_image1

String

身份证人像面图像数据,使用base64编码,要求base64编码后大小不超过4M。图像各边的像素大小在300到4000之间,支持JPG格式。

idcard_image2

String

身份证国徽面图像数据,使用base64编码,要求base64编码后大小不超过4M。图像各边的像素大小在300到4000之间,支持JPG格式。

face_image

String

现场人像图像数据,使用base64编码,要求base64编码后大小不超过4M。图像各边的像素大小在300到4000之间,支持JPG格式。

detail

Boolean

响应参数similarity是否详细显示,默认为false。

  • true表示响应中的similarity为0~1000的小数。
  • false表示响应中的similarity为0~100的整数。

crop

Boolean

是否允许对入参face_image进行人脸检测及图片裁剪,默认为true,表示允许。

support.huaweicloud.com/api-ivs/ivs_02_0025.html