Verify an authentication token

Verifies a customer's authentication token.

SecuritySecretApiKey or JWT or PublishableApiKey
Request
path Parameters
token
required
string

Authentication token identifier string.

Responses
200

Authentication token verified.

Response Schema: application/json
username
required
string

Username of the customer who is associated with the authentication token.

customerId
string <= 50 characters

Customer resource ID. Defaults to UUID v4.

token
string

Authentication token identifier string.

otpRequired
boolean

Specifies whether a One-Time Password (OTP) is required to exchange the authentication token.

credentialId
string <= 50 characters

ID of the user associated with the authentication token.

expiredTime
string <date-time>

Date and time at which the token expired.

Array of objects (Self) non-empty

Related resource links.

Array (non-empty)
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/authentication-tokens/{token}
Request samples
$isVerified = $client->authenticationTokens()->verify('token');
Response samples
application/json
{
  • "username": "string",
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "token": "string",
  • "otpRequired": true,
  • "credentialId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "expiredTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}