检索个人图像和“现场”图像视频的结果
/aivpersonvrfy
Method : GET
URL : https://xxx.finexusgroup.com/AIV/rest/v1/aivpersonvrfy
信息
这个方法将检索先前提交的特定 /aivpersonvrfy POST 请求的结果。
- 对于 同步交互模式(mode为“SYNC”),如果请求在返回响应之前被提前终止,可以使用此方法来获取先前提交的POST请求的结果;
- 对于 异步交互模式(mode为“ASYNC”),可以使用此方法在等待特定时间间隔后获取先前提交的POST请求的结果。
- 请求
- 响应
请求参数
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
source | 是 | 字符串 | 16 | 来源。 | "FNXCRDS" |
partnerId | 是 | 字符串 | 128 | 合作伙伴ID。 | "BSSS" |
productType | 可选 | 字符串 | 128 | 产品类型。 | "appTest" |
reference | 是 | 字符串 | 64 | 参考。 | "ID00000213132" |
apiKey | 有条件 | 字符串 | 64 | API密钥。 | "1233214HSC" |
apiVersion | 是 | 字符串 | 8 | API版本。 | "1.6" |
referenceId | 是 | 字符串 | 64 | 参考ID。 | "272391d1cc5840b2abfb7340a317e353f9eswc4nyQ0CEqw" |
language | 可选 | 字符串 | 2 | 语言。 | "en","ms" |
响应代码
响应代码 | 描述 | 响应模式 |
---|---|---|
200 | 服务能够验证并允许调用者使用服务和方法。 | AIVPersonVrfyGetResponse |
400 | 请求错误,服务无法按预期找到消息布局。 | N/A |
401 | 未经授权的访问 - 无法验证源系统。 | N/A |
405 | 禁止访问 - 源系统未被授权执行操作。 | N/A |
响应参数
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
status | 是 | 对象 | 状态。 | 参阅下文说明 | |
payload | 可选 | 对象 | 早期CDD Post响应的字段布局。 | 参阅下文说明 |
对象: status
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
sourceInfo | 是 | 对象 | 来源信息。 | 参阅下文说明 | |
status | 是 | 字符串 | 16 | 状态。 | "SUCCESS","FAIL","QUEUED" |
errorList | 是 | 对象 | 错误列表。 | 参阅下文说明 |
对象: sourceInfo
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
source | 是 | 字符串 | 16 | 来源。 | "FNXCRDS" |
partnerId | 是 | 字符串 | 128 | 合作伙伴ID。 | "BSSS" |
productType | 可选 | 字符串 | 128 | 合作伙伴类型。 | "appTest" |
reference | 是 | 字符串 | 64 | 参考。 | "ID00000213132" |
apiVersion | 是 | 字符串 | 8 | API版本。 | "1.6" |
apiKey | 有条件 | 字符串 | 64 | API密钥。 | "1233214HSC" |
userId | 可选 | 字符串 | 32 | 用户ID。 | "mkchan" |
userToken | 可选 | 字符串 | 64 | 用户令牌。 | "APPOKJSID8J1234" |
对象: errorList
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
msgCode | 是 | 字符串 | 8 | 消息代码。 | "000" |
msgText | 是 | 字符串 | 128 | 消息文本。 |
对象: 负载
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
status | 是 | 对象 | 状态。 | 参阅下文说明 | |
payload | 是 | 对象 | 类似度测试结果的信息。 | 参阅下文说明 |
对象: status
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
sourceInfo | 是 | 对象 | 来源信息。 | 参阅下文说明 | |
status | 是 | 字符串 | 16 | 状态。 | "SUCCESS", "FAIL", "QUEUED" |
errorList | 是 | 对象 | 错误列表。 | 参阅下文说明 |
对象: sourceInfo
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
source | 是 | 字符串 | 16 | 来源。 | "FNXCRDS" |
partnerId | 是 | 字符串 | 128 | 合作伙伴ID。 | "BSSS" |
productType | 可选 | 字符串 | 128 | 合作伙伴类型。 | "appTest" |
reference | 是 | 字符串 | 64 | 参考。 | "ID00000213132" |
apiVersion | 是 | 字符串 | 8 | API版本。 | "1.6" |
apiKey | 有条件 | 字符串 | 64 | API密钥。 | "1233214HSC" |
userId | 可选 | 字符串 | 32 | 用户ID。 | "mkchan" |
userToken | 可选 | 字符串 | 64 | 用户令牌。 | "APPOKJSID8J1234" |
对象: errorList
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
msgCode | 是 | 字符串 | 8 | 消息代码。 | "000" |
msgText | 是 | 字符串 | 128 | 消息文本。 |
对象: payload
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
resembleFlg | 是 | 字符串 | 1 | 类似度标志。 | "t","f" |
degreeOfResemblance | 是 | 字符串 (数值) | 4 | 类似度程度。 | "100" |
bestImageFrame | 是 | 对象 | 最佳图像框。 | 参阅下文说明 |
对象: bestImageFrame
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
contentEncoding | 是 | 字符串 | 16 | 图像的编码格式。 | "base64" |
contentMediaType | 是 | 字符串 | 16 | 图像数据的媒体类型。 | "jpeg" |
image | 是 | 字符串 | 整个图像数据。 | "/9j/4AAQSkZJRgABAQ" |
示例消息
- 请求
- 响应
/aivpersonvrfy GET 请求
curl -X GET "https://xxx.finexusgroup.com/AIV/rest/clientauth/aivpersonvrfy?source=FNXCRDS&partnerId=BSSS&productType=appTest&reference=ID00000213132&apiVersion=1.6&referenceId=272391d1cc5840b2abfb7340a317e353f9eswc4nyQ0CEqw&apiKey=1233214HSC" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
/aivpersonvrfy GET 响应
{
"status": {
"sourceInfo": {
"reference": "ID00000213132",
"apiVersion": "1.6",
"apiKey": "1233214HSC",
"source": "FNXCARDS",
"partnerId": "BSSS"
"productType": "appTest"
"referenceId": "272391d1cc5840b2abfb7340a317e353f9eswc4nyQ0CEqw",
"language": "en"
},
"errorList": [
{
"msgText": "",
"msgCode": ""
}
],
"status": "SUCCESS"
},
"payload": {
"status": {
"sourceInfo": {
"reference": "ID00000213132",
"apiVersion": "1.6",
"apiKey": "1233214HSC",
"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"
}
}
}
}