退出 ACDD

/logout

Method : POST
URL : https://xxx.finexusgroup.com/acdd/rest/v1/logout

信息

这项服务是允许通过eKYC Web应用程序登出apiKey的会话。

请求

请求参数

字段名	是否必需	类型	长度	描述	示例
sourceInfo	是	对象		来源信息	参阅下文说明
interactionMode	是	对象		交互模式	参阅下文说明
language	可选	字符串	2	语言	"en"

对象: sourceInfo

字段名	是否必需	类型	长度	描述	示例
source	是	字符串	16	来源	"FNXCRDS"
partnerID	是	字符串	128	合作伙伴 ID	"BSSS"
productType	是	字符串	128	产品类型	"loanapplication"
reference	是	字符串	64	参考	"50074154501001"
apiVersion	是	字符串	8	API 版本	"1.2"
apiKey	可选	字符串	64	API 密钥	"123KEJRU001"
userId	可选	字符串	32	用户 ID	"u125"
userToken	可选	字符串	64	用户令牌	"Cb1sci18j2UvNLsq4"

对象: interactionMode

字段名	是否必需	类型	长度	描述	示例
mode	是	字符串	8	模式	"SYNC","ASYNC"
callbackUrl	可选	字符串	256	回调 URL	"www.google.com"

响应

响应参数

响应码	描述	响应模式
200	允许	CDDPostResponse
400	错误请求	N/A
401	未授权访问	N/A
405	拒绝访问	N/A

响应参数

字段名	是否必需	类型	长度	描述	示例
status	是	对象		状态	参阅下文说明
payload	可选	对象		注销响应	参阅下文说明

对象: status

字段名	是否必需	类型	长度	描述	示例
sourceInfo	是	对象		来源信息	参阅下文说明
errorlist	是	对象		错误列表	参阅下文说明
status	是	字符串	16	状态	"SUCCESS","QUEUED","FAIL"

对象: payload

字段名	是否必需	类型	长度	描述	示例
message	是	字符串	64	注销响应消息	"Logout successfully."

对象: sourceInfo

字段名	是否必需	类型	长度	描述	示例
source	是	字符串	16	来源	"FNXCRDS"
partnerID	是	字符串	128	合作伙伴 ID	"BSSS"
productType	是	字符串	128	产品类型	"loanapplication"
reference	是	字符串	64	参考	"50074154501001"
apiVersion	是	字符串	8	API 版本	"1.2"
apiKey	可选	字符串	64	API 密钥	"123KEJRU001"
userId	可选	字符串	32	用户 ID	"u125"
userToken	可选	字符串	64	用户令牌	"Cb1sci18j2UvNLsq4"

对象: errorList

字段名	是否必需	类型	长度	描述	示例
msgText	是	字符串	128	消息文本	"Logout unsuccessful."
msgCode	是	字符串	8	消息代码	"404"

示例消息

请求

/logout POST 请求

{
  "sourceInfo": {
    "source": "mxx",
    "partnerId": "BSSS",
    "productType": "LoanApplication",
    "reference": "refYAMLxxxxxlVxxCxxTHE34xxx0PxxKkxxxx",
    "apiVersion": "1.3",
    "apiKey": "xxxr9vxxxgWfxxxAi6xxxExYjxxxkD8E",
    "userId": "mkchan",
    "userToken": "APPxxxJxIxxx23x"
  },
  "interactionMode": {
    "mode": "SYNC",
    "callbackUrl": "string"
  },
  "language": "en"
}

响应

/logout POST 响应

{
  "status": {
    "sourceInfo": {
      "source": "FNXCRDS",
      "partnerId": "BSSS",
      "productType": "LoanApplication",
      "reference": "refYAMLxxxxxlVxxCxxTHE34xxx0PxxKkxxxx",
      "apiVersion": "1.3",
      "apiKey": "xxxr9vxxxgWfxxxAi6xxxExYjxxxkD8E",
      "userId": "mkchan",
      "userToken": "APPxxxJxIxxx23x"
    },
    "errorList": [
      {
        "msgText": "",
        "msgCode": ""
      }
    ],
    "status": "SUCCESS"
  },
  "payload": {
    "message": "Logout successfully"
  }
}