检索已上传的支持文件

/aivpor

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

信息

这个方法将检索之前 /aivpor 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	服务能够验证并允许调用者使用该服务和方法。	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

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

示例消息

请求

/aivpor GET 请求

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

响应

/aivpor GET 响应

{
    "sourceInfo": {
        "source": "FNXCRDS",
        "partnerId": "BSSS",
        "reference": "ID00000213132",
        "apiVersion": "1.6",
        "apiKey": "1233214HSC",
        "productType": "Card application",
      "referenceId": "272391d1cc5840b2abfb7340a317e353f9eswc4nyQ0CEqw",
      "language": "en"
    },
    "payload": {
        "status": {
            "sourceInfo": {
                "source": "FNXCRDS",
                "partnerId": "BSSS",
                "reference": "ID00000213132",
                "apiVersion": "1.6",
                "apiKey": "1233214HSC",
                "productType": "Card application",
                "userId": "mkchan",
                "userToken": "APPOKJSID8J1234"
            },
            "errorList": [
                {
                    "msgText": "",
                    "msgCode": "000"
                }
            ],
            "status": "SUCCESS"
        },
        "payload": {
            "docData": {
                "documentType": "Water Bill",
                "contentMediaTye": "PDF",
                "contentEncoding": "BASE64",
                "document": "iVBORw0KGgoAAAANSUhEUgAAApkAAAG"
            }
        }
    }
}