上传支持文件

/aivpor

Method : POST
URL : https://xxx.finexusgroup.com/AIV/rest/v1/aivpor

信息

这个方法允许提交一个请求，上传图像或 PDF 文件作为识别和验证个人的支持文件。

响应将包括请求的参考 ID，以便稍后能够检索到该文件。

请求

请求参数

字段名称	必填	类型	描述	示例
sourceInfo	是	对象	来源信息。	参阅下文说明。
interactionMode	是	对象	交互模式。	参阅下文说明。
language	可选	字符串	语言。	"en"
fullName	是	字符串	全名。	"James Smith"
mobileNo	是	字符串	手机号码。	"0128123456"
address	是	对象	地址。	参阅下文说明。
docData	是	对象	文档数据。	参阅下文说明。

对象：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。

对象：address

字段名称	必填	类型	描述	示例
addrLine1	是	字符串	地址行 1。	"No.1, Jalan Manis"
addrLine2	可选	字符串	地址行 2。	"Jalan Pangkor"
addrLine3	可选	字符串	地址行 3。
city	是	字符串	城市。	"Kuala Lumpur"
state	是	字符串	州。	"Wilayah Persekutuan Kuala Lumpur"
country	条件性	字符串	国家代码。
postcode	是	数字	邮政编码。	"50000"

对象：docData

字段名称	必填	类型	描述	示例
contentEncoding	是	字符串	文档的编码格式。	"base64"
contentMediaType	是	字符串	文档数据的媒体类型。	"PDF"
image	是	字符串	整个文档数据。	"iVBORw0KGgoAAAANSUhEUgAAApkAAAG"
documentType	是	字符串	文档类型。	"Water Bill"

响应

响应代码

响应代码	描述	响应架构
200	服务能够验证并允许调用者使用服务和方法。	DocumentDetails
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

字段名称	必填	类型	描述	示例
contentEncoding	是	字符串	文档的编码格式。	"base64"
contentMediaType	是	字符串	文档数据的媒体类型。	"PDF"
image	是	字符串	整个文档数据。	"iVBORw0KGgoAAAANSUhEUgAAApkAAAG"
documentType	是	字符串	文档类型。	"Water Bill"

示例消息

请求

/aivpor POST 请求

curl -X POST "https://xxx.finexusgroup.com/AIV/rest/clientauth/aivpor" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \ 
 -d '{
        "sourceInfo": {
            "source": "FNXCRDS",
            "partnerId": "BSSS",
            "reference": "220610181940",
            "apiVersion": "1.6",
            "apiKey": "123KUJR003",
            "productType": "Card application",
            "userId": "mkchan",
            "userToken": "APPOKJSID8J1234"
        },
        "interactionMode": {
            "mode": "SYNC",
            "callBackUrl": ""
        },
        "language": "en",
        "fullName": "James Smith",
        "mobileNo": "0128123456",
        "address": {
            "addrLine1": "No.1, Jalan Manis",
            "addrLine2": "Jalan Pangkor",
            "addrLine3": "",
            "city": "Kuala Lumpur",
            "state": "Wilayah Persekutuan Kuala Lumpur",
        "postcode": "50000"
        },
        "docData": {
            "documentType": "Water Bill",
            "contentMediaTye": "PDF",
            "contentEncoding": "BASE64",
            "document": "iVBORw0KGgoAAAANSUhEUgAAApkAAAG"
        }
    }'

响应

/aivpor POST 响应

{
    "status": {
        "sourceInfo": {
            "source": "FNXCRDS",
            "partnerId": "BSSS",
            "reference": "220610181940",
            "apiVersion": "1.6",
            "apiKey": "123KUJR003",
            "productType": "Card application",
            "userId": "mkchan",
            "userToken": "APPOKJSID8J1234"
        },
        "errorList": [
            {
                "msgText": "",
                "msgCode": "000"
            }
        ],
        "status": "SUCCESS"
    },
    "payload": {
        "docData": {
            "documentType": "Water Bill",
            "contentMediaTye": "PDF",
            "contentEncoding": "BASE64",
            "document": "iVBORw0KGgoAAAANSUhEUgAAApkAAAG"
        }
    }
}