从 AIV 注销

/aivlogout

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

信息

该服务允许 eKYC Web 应用程序提交以从 apiKey 的会话中注销。

请求

请求参数

字段名	必填	类型	长度	描述	示例
sourceInfo	是	对象		源信息。	参阅下文说明
interactionMode	是	对象		交互模式。	参阅下文说明

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

对象：interactionMode

字段名	必填	类型	长度	描述	示例
mode	是	字符串	8	模式。	"SYNC", "ASYNC"
callbackUrl	可选	字符串	256	回调URL。

响应

响应代码

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

响应参数

字段名	必填	类型	长度	描述	示例
status	是	对象		状态。	参阅下文说明
payload	可选	对象		AIV注销信息。	参阅下文说明

对象：status

字段名	必填	类型	长度	描述	示例
sourceInfo	是	对象		源信息。	参阅下文说明
errorList	是	数组对象		错误列表。	参阅下文说明
status	是	字符串	16	状态。	"SUCCESS", "FAIL"

对象：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	消息代码。
msgText	是	字符串	128	消息文本。

对象：payload

字段名	必填	类型	长度	描述	示例
message	是	字符串	50	消息。	"Logout successfully"

示例消息

请求

/aivlogout POST 响应

curl -X POST "https://xxx.finexusgroup.com/AIV/rest/clientauth/aivlogout" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \ 
 -d '{
          "sourceInfo": {
               "source": "test",
               "partnerId": "test",
               "apiVersion": "1.6",
               "reference": "ID00000213132",
               "apiKey": "1233214HSC"
          },
          "interactionMode": {
               "mode": "async"
          }
     }'

响应

/aivlogout POST 响应

{
    "status": {
        "sourceInfo": {
            "source": "test",
            "partnerId": "test",
            "apiVersion": "1.6",
            "reference": "ID00000213132",
            "apiKey": "1233214HSC"
        },
        "errorList": [
            {
                "msgText": "",
                "msgCode": ""
            }
        ],
        "status": "SUCCESS"
    },
    "payload": {
        "message": "Logout successfully"
    }
}