Developer docs
/
Rebilly API
/
Customer authentication
/
Verify an authentication token

Verify an authentication token

Verifies a customer's authentication token.

SecurityAPI Key: SecretApiKey or HTTP: JWT or API Key: PublishableApiKey
Request
path Parameters
token
required
string

ID of the authentication token.

get
/authentication-tokens/{token}
Request samples
$isVerified = $client->authenticationTokens()->verify('token');
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

ID of the customer resource.

token
string

ID of the authentication token.

otpRequired
boolean

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

credentialId
string (ResourceId) <= 50 characters

Unique resource ID.

expiredTime
string or null <date-time>

Date and time when the token expired.

Array of objects (SelfLink)

Related links.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

Response samples
application/json
{
"username": "string",
"customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
"token": "string",
"otpRequired": true,
"credentialId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"expiredTime": "2019-08-24T14:15:22Z",
"_links": [

]
}