Logout from AIV

/aivlogout

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

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	Description	Example
sourceInfo	Yes	Object	Source information.	Refer to explanation below.
interactionMode	Yes	Object	Interaction mode.	Refer to explanation below.

Object: sourceInfo

Field Name	Required	Type	Description	Example
source	Yes	String	Source.	"FNXCRDS"
partnerId	Yes	String	Partner ID.	"BSSS"
productType	Optional	String	Partner type.	"appTest"
reference	Yes	String	Reference.	"2003160192931"
apiVersion	Yes	String	API version.	"1.6"
apiKey	Conditional	String	API key.	"123-KEJRU-001"
userId	Optional	String	User ID.	"mkchan"
userToken	Optional	String	User token.	"APPOKJSID8J1234"

Object: interactionMode

Field Name	Required	Type	Description	Example
mode	Yes	String	Mode.	"ASYNC"
callbackUrl	Optional	String	Callback URL.

Response

Response Codes

Response Code	Description	Response Schema
200	The service is able to authenticate and allow the caller to use the service and method.	AIVLogoutResponse
400	Bad request whereby the service cannot find the message layout as expected.	N/A
401	Unauthorised access - unable to authenticate source system	N/A
405	Forbidden access - source system is not authorised to perform an action	N/A

Response Parameters

Field Name	Required	Type	Description	Example
status	Yes	Object	Status.	Refer to explanation below.
payload	Optional	Object	AIV logout information.	Refer to explanation below.

Object: status

Field Name	Required	Type	Description	Example
sourceInfo	Yes	Object	Source information.	Refer to explanation below.
errorList	Yes	Array Object	Error list.	Refer to explanation below.
status	Yes	String	Status.	"SUCCESS"

Object: sourceInfo

Field Name	Required	Type	Description	Example
source	Yes	String	Source.	"FNXCRDS"
partnerId	Yes	String	Partner ID.	"BSSS"
productType	Optional	String	Partner type.	"appTest"
reference	Yes	String	Reference.	"2003160192931"
apiVersion	Yes	String	API version.	"1.6"
apiKey	Conditional	String	API key.	"123-KEJRU-001"
userId	Optional	String	User ID.	"mkchan"
userToken	Optional	String	User token.	"APPOKJSID8J1234"

Object: errorList

Field Name	Required	Type	Description	Example
msgCode	Yes	String	Message code.	"000"
msgText	Yes	String	Message text.

Object: payload

Field Name	Required	Type	Description	Example
message	Yes	String	Message.	"Logout successfully"

Example Message

Request

/aivlogout POST Request

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": "e19342b2e6074364bb51af270db71fa6Vc38TdFyPHcCEqg9",
               "apiKey": "1F4ABF0D68F49A43A21C6C5F163CAB5"
          },
          "interactionMode": {
               "mode": "async"
          }
     }'

Response

/aivlogout POST Response

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