Logout Fields
1 min
POST
https://adi.accertify.net/api/identity/v1/logout
Body Parameters
- logoutobjectDescription
- eventSourcestring<agentPhone | agentStore | affiliate | kiosk | mobileApp | other | web>requiredDescriptionAllowedagentPhoneagentStoreaffiliatekioskmobileAppotherweb
- accountIDstringrequiredDescription
- ipAddressstringExampleDescription
- userAgentstringExampleDescription
- devicePayloadstringExampleDescription
- deviceTransactionIDstringExampleDescription
- ubaIDstringExampleDescription
- emailAddressstringExampleDescription
- ubaEventsstringExampleDescription
- pageIDstringExampleDescription
- usernamestringExampleDescription
- authenticationMethodstring<appAuthenticator | appPush | FIDO | other | password | magicLink | SMS>DescriptionAllowedappAuthenticatorappPushFIDOotherpasswordmagicLinkSMS
- latitudenumberExampleDescription
- longitudenumberExampleDescription
- brandstringExampleDescription
- sessionIDstringExampleDescription
- ubaSessionIDstringExampleDescription
Responses
200
- successResponseIDMsgStatusExample
{ "eventID": "GK76NPO=zaeit1di9+DCJEDYUAvu90hLEvc", "messages": { "warning": [], "error": [], "info": [] }, "status": true }Description- statusbooleanDescription
- eventIDstringDescription
- messagesobject
- errorstring[]
- warningstring[]
- infostring[]
400
- errorResponseExample
{ "messages": { "warning": [], "error": [ "card number appears to be plaintext" ], "info": [] }, "status": false }Description- statusbooleanDescription
- messagesobject
- errorstring[]
- warningstring[]
- infostring[]
401
- errorResponseExample
{ "messages": { "warning": [], "error": [ "card number appears to be plaintext" ], "info": [] }, "status": false }Description- statusbooleanDescription
- messagesobject
- errorstring[]
- warningstring[]
- infostring[]
403
- errorResponseExample
{ "messages": { "warning": [], "error": [ "card number appears to be plaintext" ], "info": [] }, "status": false }Description- statusbooleanDescription
- messagesobject
- errorstring[]
- warningstring[]
- infostring[]
405
- errorResponseExample
{ "messages": { "warning": [], "error": [ "card number appears to be plaintext" ], "info": [] }, "status": false }Description- statusbooleanDescription
- messagesobject
- errorstring[]
- warningstring[]
- infostring[]
412
- errorResponseExample
{ "messages": { "warning": [], "error": [ "card number appears to be plaintext" ], "info": [] }, "status": false }Description- statusbooleanDescription
- messagesobject
- errorstring[]
- warningstring[]
- infostring[]
429
- errorResponseExample
{ "messages": { "warning": [], "error": [ "card number appears to be plaintext" ], "info": [] }, "status": false }Description- statusbooleanDescription
- messagesobject
- errorstring[]
- warningstring[]
- infostring[]
500
- errorResponseExample
{ "messages": { "warning": [], "error": [ "card number appears to be plaintext" ], "info": [] }, "status": false }Description- statusbooleanDescription
- messagesobject
- errorstring[]
- warningstring[]
- infostring[]
curl
curl --request POST \
--url https://adi.accertify.net/api/identity/v1/logout \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"eventSource": "",
"accountID": ""
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"eventSource": "",
"accountID": ""
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://adi.accertify.net/api/identity/v1/logout", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://adi.accertify.net/api/identity/v1/logout")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
"eventSource": "",
"accountID": ""
})
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://adi.accertify.net/api/identity/v1/logout"
payload = json.dumps({
"eventSource": "",
"accountID": ""
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// Success response with just Event ID, Message, and Status. For Logout events
{
"status": false,
"eventID": "",
"messages": {
"error": [
""
],
"warning": [
""
],
"info": [
""
]
}
}400
// Bad Request. Usually indicates a message that cannot be parsed or fails validation.
{
"status": false,
"messages": {
"error": [
""
],
"warning": [
""
],
"info": [
""
]
}
}401
// Unauthorized. Invalid credentials.
{
"status": false,
"messages": {
"error": [
""
],
"warning": [
""
],
"info": [
""
]
}
}403
// Forbidden. Event was stopped by Gatekeeper checks.
{
"status": false,
"messages": {
"error": [
""
],
"warning": [
""
],
"info": [
""
]
}
}405
// Method Not Allowed. Indicates an HTTP request method other than POST.
{
"status": false,
"messages": {
"error": [
""
],
"warning": [
""
],
"info": [
""
]
}
}412
// Precondition Failed. Exceeded event rate limit for test API configurations.
{
"status": false,
"messages": {
"error": [
""
],
"warning": [
""
],
"info": [
""
]
}
}429
// Too Many Requests. Rate limit exceeded.
{
"status": false,
"messages": {
"error": [
""
],
"warning": [
""
],
"info": [
""
]
}
}500
// Internal Server Error.
{
"status": false,
"messages": {
"error": [
""
],
"warning": [
""
],
"info": [
""
]
}
}