Logout from ACDD

/logout

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

info

This service is to allow the submission of eKYC web app to log out from the apiKey’s session.

Request

Request Parameters

Field Name	Required	Type	Length	Description	Example
sourceInfo	Yes	Object		Source information.	Refer to explanation below.
interactionMode	Yes	Object		Interaction mode.	Refer to explanation below.
language	Optional	String	2	Language.	"en"

Object: sourceInfo

Field Name	Required	Type	Length	Description	Example
source	Yes	String	16	Source.	"FNXCRDS"
partnerID	Yes	String	128	Partner ID.	"BSSS"
productType	Yes	String	128	Product type.	"loanapplication"
reference	Yes	String	64	Reference.	"50074154501001"
apiVersion	Yes	String	8	API Version.	"1.2"
apiKey	Optional	String	64	API Key.	"123KEJRU001"
userId	Optional	String	32	User ID.	"u125"
userToken	Optional	String	64	User Token.	"Cb1sci18j2UvNLsq4"

Object: interactionMode

Field Name	Required	Type	Length	Description	Example
mode	Yes	String	8	Mode.	"SYNC","ASYNC"
callbackUrl	Optional	String	256	Call back URL.	"www.google.com"

Response

Response Codes

Response Code	Description	Response Schema
200	Allow.	CDDPostResponse
400	Bad request.	N/A
401	Unauthorised access.	N/A
405	Forbidden access.	N/A

Response Parameters

Field Name	Required	Type	Length	Description	Example
status	Yes	Object		Status.	Refer to explanation below.
payload	Optional	Object		Logout response.	Refer to explanation below.

Object: status

Field Name	Required	Type	Length	Description	Example
sourceInfo	Yes	Object		Source information.	Refer to explanation below.
errorlist	Yes	Object		Error list.	Refer to explanation below.
status	Yes	String	16	Status.	"SUCCESS","QUEUED","FAIL"

Object: payload

Field Name	Required	Type	Length	Description	Example
message	Yes	String	64	Logout response message.	"Logout successfully."

Object: sourceInfo

Field Name	Required	Type	Length	Description	Example
source	Yes	String	16	Source.	"FNXCRDS"
partnerID	Yes	String	128	Partner ID.	"BSSS"
productType	Yes	String	128	Product type.	"loanapplication"
reference	Yes	String	64	Reference.	"50074154501001"
apiVersion	Yes	String	8	API Version.	"1.2"
apiKey	Optional	String	64	API Key.	"123KEJRU001"
userId	Optional	String	32	User ID.	"u125"
userToken	Optional	String	64	User Token.	"Cb1sci18j2UvNLsq4"

Object: errorList

Field Name	Required	Type	Length	Description	Example
msgText	Yes	String	128	Message text.	"Logout unsuccessful."
msgCode	Yes	String	8	Message code.	"404"

Example Message

Request

/logout POST Request

{
  "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"
}

Response

/logout POST Response

{
  "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"
  }
}