提交个人的 '现场' 图像视频
/aivpersonvrfy
Method : POST
URL : https://xxx.finexusgroup.com/AIV/rest/v1/aivpersonvrfy
Desc :
信息
这项服务将检查持有人的 "现场" 图像视频与身份证件中持有人图像之间的相似性。
此请求所需的输入包括:
之前提交的 /aivpersonidtfy POST 请求的 referenceId
,以便 AIV 检索申请人从身份证件中提取的图像。
申请人提交一段 3 到 5 秒钟的 "现场" 视频,以便我们可以与从身份证件中提取的申请人图像进行比对。
响应将包括:
评估申请人的 "现场" 视频中的面部是否与身份证件图像有任何相似之处; 相似度的程度,以百分比表示,并显示与身份证件图像具有最高相似度的视频图像。
- 请求
- 响应
请求参数
字段名称 | 必填 | 类型 | 描述 | 示例 |
---|---|---|---|---|
sourceInfo | 是 | 对象 | 源信息。 | 参阅下文说明。 |
interactionMode | 是 | 对象 | 交互模式。 | 参阅下文说明。 |
language | 可选 | 字符串 | 语言。 | "en" |
aivRefId | 是 | 字符串 | AIV 参考 ID。 | "2003160192931" |
holderFaceVideo | 是 | 对象 | 申请人面部的“现场”视频。 | 参阅下文说明。 |
对象:sourceInfo
字段名称 | 必填 | 类型 | 描述 | 示例 |
---|---|---|---|---|
source | 是 | 字符串 | 来源。 | "FNXCRDS" |
partnerId | 是 | 字符串 | 合作伙伴 ID。 | "BSSS" |
productType | 可选 | 字符串 | 合作伙伴类型。 | "appTest" |
reference | 是 | 字符串 | 参考。 | "2003160192931" |
apiVersion | 是 | 字符串 | API 版本。 | "1.6" |
apiKey | 条件性 | 字符串 | API 密钥。 | "123-KEJRU-001" |
userId | 可选 | 字符串 | 用户 ID。 | "mkchan" |
userToken | 可选 | 字符串 | 用户令牌。 | "APPOKJSID8J1234" |
对象:interactionMode
字段名称 | 必填 | 类型 | 描述 | 示例 |
---|---|---|---|---|
mode | 是 | 字符串 | 模式。 | "ASYNC" |
callbackUrl | 可选 | 字符串 | 回调 URL。 |
对象:holderFaceVideo
字段名称 | 必填 | 类型 | 描述 | 示例 |
---|---|---|---|---|
contentEncoding | 是 | 字符串 | 视频的编码格式。 | "base64" |
contentMediaType | 是 | 字符串 | 视频数据的介质。 | "mp4" |
video | 是 | 字符串 | 整个视频数据。 | "AAAAGGZ0eXBtcDQyA" |
响应代码
响应代码 | 描述 | 响应架构 |
---|---|---|
200 | 服务能够验证并允许调用者使用服务和方法。 | AIVPersonVrfyPostResponse |
400 | 请求错误,服务无法按预期找到消息布局。 | N/A |
401 | 未经授权访问 - 无法对来源系统进行身份验证。 | N/A |
405 | 禁止访问 - 源系统未被授权执行操作。 | N/A |
响应参数
字段名称 | 必填 | 类型 | 描述 | 示例 |
---|---|---|---|---|
status | 是 | 对象 | 状态 | 参阅下文说明。 |
payload | 可选 | 对象 | 申请人面部在“现场”视频中的提取图像之间相似性检查的结果。 | 参阅下文说明。 |
对象:status
字段名称 | 必填 | 类型 | 描述 | 示例 |
---|---|---|---|---|
sourceInfo | 是 | 对象 | 源信息。 | 参阅下文说明。 |
status | 是 | 字符串 | 状态。 | "SUCCESS" |
errorList | 是 | 对象 | 错误列表。 | 参阅下文说明。 |
对象:sourceInfo
字段名称 | 必填 | 类型 | 描述 | 示例 |
---|---|---|---|---|
source | 是 | 字符串 | 来源。 | "FNXCRDS" |
partnerId | 是 | 字符串 | 合作伙伴 ID。 | "BSSS" |
productType | 可选 | 字符串 | 合作伙伴类型。 | "appTest" |
reference | 是 | 字符串 | 参考。 | "2003160192931" |
apiVersion | 是 | 字符串 | API 版本。 | "1.6" |
apiKey | 条件性 | 字符串 | API 密钥。 | "123-KEJRU-001" |
userId | 可选 | 字符串 | 用户 ID。 | "mkchan" |
userToken | 可选 | 字符串 | 用户令牌。 | "APPOKJSID8J1234" |
对象:errorList
字段名称 | 必填 | 类型 | 描述 | 示例 |
---|---|---|---|---|
msgCode | 是 | 字符串 | 消息代码。 | "000" |
msgText | 是 | 字符串 | 消息文本。 |
对象:payload
字段名称 | 必填 | 类型 | 描述 | 示例 |
---|---|---|---|---|
resembleFlg | 是 | 字符串 | 相似度标志。 | "t" |
degreeOfResemblance | 是 | 数字 | 相似度程度。 | "100" |
bestImageFrame | 是 | 对象 | 最佳图像帧。 | 参阅下文说明。 |
对象:bestImageFrame
字段名称 | 必填 | 类型 | 描述 | 示例 |
---|---|---|---|---|
contentEncoding | 是 | 字符串 | 图像的编码格式。 | "base64" |
contentMediaType | 是 | 字符串 | 图像数据的媒体类型。 | "jpeg" |
image | 是 | 字符串 | 整个图像数据。 | "/9j/4AAQSkZJRgABAQ" |
示例消息
- 请求
- 响应
/aivpersonvrfy POST 请求
curl -X POST "https://xxx.finexusgroup.com/AIV/rest/clientauth/aivpersonvrfy" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"sourceInfo": {
"reference": "205",
"apiVersion": "1.6",
"apiKey": "ABC1234567",
"source": "FNXCARDS",
"partnerId": "BSSS",
"productType": "appTest",
"userId": "mkchan",
"userToken": "APPOKJJSIDJ1234"
},
"interactionMode": {
"mode": "SYNC",
"callbackUrl": ""
},
"language": "en",
"aivRefId": "73",
"holderFaceVideo": {
"contentEncoding": "base64",
"contentMediaType": "mp4",
"video": "AAAAGGZ0eXBtcDQyA"
}
}'
/aivpersonvrfy POST 响应
{
"status": {
"sourceInfo": {
"reference": "205",
"apiVersion": "1.6",
"apiKey": "ABC1234567",
"source": "FNXCARDS",
"partnerId": "BSSS",
"productType": "appTest",
"userId": "mkchan",
"userToken": "APPOKJJSIDJ1234"
},
"errorList": [
{
"msgText": "",
"msgCode": ""
}
],
"status": "SUCCESS"
},
"payload": {
"resembleFlg": "t",
"degreeofResemblance": 100,
"bestImageFrame": {
"image": "/9j/4AAQSkZJRgABAQ"
"contentMediaType": "jpeg",
"contentEncoding": "base64"
}
}
}