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
- Response
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. |
Object: sourceInfo
Field Name | Required | Type | Length | Description | Example |
---|---|---|---|---|---|
source | Yes | String | 16 | Source. | "FNXCRDS" |
partnerId | Yes | String | 128 | Partner ID. | "BSSS" |
productType | Optional | String | 128 | Partner type. | "appTest" |
reference | Yes | String | 64 | Reference. | "ID00000213132" |
apiVersion | Yes | String | 8 | API version. | "1.6" |
apiKey | Conditional | String | 64 | API key. | "1233214HSC" |
userId | Optional | String | 32 | User ID. | "mkchan" |
userToken | Optional | String | 64 | User token. | "APPOKJSID8J1234" |
Object: interactionMode
Field Name | Required | Type | Length | Description | Example |
---|---|---|---|---|---|
mode | Yes | String | 8 | Mode. | "SYNC", "ASYNC" |
callbackUrl | Optional | String | 256 | Callback URL. |
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 | Length | 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 | Length | Description | Example |
---|---|---|---|---|---|
sourceInfo | Yes | Object | Source information. | Refer to explanation below. | |
errorList | Yes | Array Object | Error list. | Refer to explanation below. | |
status | Yes | String | 16 | Status. | "SUCCESS", "FAIL" |
Object: sourceInfo
Field Name | Required | Type | Length | Description | Example |
---|---|---|---|---|---|
source | Yes | String | 16 | Source. | "FNXCRDS" |
partnerId | Yes | String | 128 | Partner ID. | "BSSS" |
productType | Optional | String | 128 | Partner type. | "appTest" |
reference | Yes | String | 64 | Reference. | "ID00000213132" |
apiVersion | Yes | String | 8 | API version. | "1.6" |
apiKey | Conditional | String | 64 | API key. | "1233214HSC" |
userId | Optional | String | 32 | User ID. | "mkchan" |
userToken | Optional | String | 64 | User token. | "APPOKJSID8J1234" |
Object: errorList
Field Name | Required | Type | Length | Description | Example |
---|---|---|---|---|---|
msgCode | Yes | String | 8 | Message code. | |
msgText | Yes | String | 128 | Message text. |
Object: payload
Field Name | Required | Type | Length | Description | Example |
---|---|---|---|---|---|
message | Yes | String | 50 | Message. | "Logout successfully" |
Example Message
- Request
- Response
/aivlogout POST Response
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 Response
{
"status": {
"sourceInfo": {
"source": "test",
"partnerId": "test",
"apiVersion": "1.6",
"reference": "ID00000213132",
"apiKey": "1233214HSC"
},
"errorList": [
{
"msgText": "",
"msgCode": ""
}
],
"status": "SUCCESS"
},
"payload": {
"message": "Logout successfully"
}
}