检索个人图像和 "现场" 图像视频

/aivimageretrieval

Method : GET
URL : https://xxx.finexusgroup.com/AIV/rest/v1/aivimageretrieval

信息

这个方法将检索之前 /aivpersonidtfy POST 请求中发布的图像以及之前 /aivpersonvrfy。

请求

请求参数

字段名称	必填	类型	长度	描述	示例
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"

响应

响应状态码

响应码	描述	响应模式
200	服务能够进行身份验证并允许调用者使用服务和方法。	AivImageRetrieval
400	错误请求，服务无法按预期找到消息布局。	N/A
401	未经授权的访问 - 无法验证来源系统。	N/A
405	禁止访问 - 来源系统未经授权执行操作。	N/A

响应参数

字段名称	必填	类型	长度	描述	示例
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

字段名称	必填	类型	长度	描述	示例
images	是	对象		图片详情。	参阅下文说明
video	是	对象		视频详情。	参阅下文说明

对象: images

字段名称	必填	类型	长度	描述	示例
imageFront	是	对象		身份证正面图片内容。	参阅下文说明
imageBack	条件性	对象		身份证背面图片内容。	参阅下文说明

对象: imageFront

字段名称	必填	类型	长度	描述	示例
contentEncoding	是	字符串	16	图片的编码格式。	"base64"
contentMediaType	是	字符串	16	图片数据的媒体类型。	"jpeg"
image	是	字符串		完整的图片数据。	"/9j/4AAQSkZJRgABAQ"

对象: imageBack

字段名称	必填	类型	长度	描述	示例
contentEncoding	是	字符串	16	图片的编码格式。	"base64"
contentMediaType	是	字符串	16	图片数据的媒体类型。	"jpeg"
image	是	字符串		完整的图片数据。	"/9j/4AAQSkZJRgABAQ"

对象: video

字段名称	必填	类型	长度	描述	示例
holderFaceVideo	是	对象		申请人面部的“活体”视频内容。	参阅下文说明

对象: holderFaceVideo

字段名称	必填	类型	长度	描述	示例
contentEncoding	是	字符串	16	视频的编码格式。	"base64"
contentMediaType	是	字符串	16	视频数据的媒体类型。	"mp4"
video	是	字符串		完整的视频数据。	"AAAAGGZ0eXBtcDQyA"

示例消息

请求

/aivimageretrieval GET 请求

curl -X GET "https://xxx.finexusgroup.com/AIV/rest/clientauth/aivimageretrieval?source=FNXCRDS&partnerId=BSSS&productType=appTest&reference=ID00000213132&apiVersion=1.6& referenceId=272391d1cc5840b2abfb7340a317e353f9eswc4nyQ0CEqw&apiKey=1233214HSC" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \ 

响应

/aivimageretrieval GET 响应

{
    "status": {
        "sourceInfo": {
            "reference": "ID00000213132",
            "apiVersion": "1.6",
            "apiKey": "1233214HSC",
            "source": "AYP",
         "partnerId": "BSSS",
         "productType": "appTest"
        },
        "errorList": [
            "msgCode": "",
         "msgText": ""
        ],
        "status": "SUCCESS"
    },
    "payload": {
        "images": {
            "frontImage": {
                "image": "/9j/4AAQSkZJRgABAQAAAQABAAD",
                "contentMediaType": "image/jpeg",
                "contentEncoding": "base64"
            },
            "backImage": {
                "image": "",
                "contentMediaType": "",
                "contentEncoding": ""
            }
        },
        "video": {
            "holderFaceVideo": {
                "contentMediaType": "video/mp4",
                "contentEncoding": "base64",
                "video": "/9j/4AAQSkZJRgABAQAAAQABA"
            }
        }
    }
}