<- OAuth API

OAuth API

Retrieve token status

POST

 /oauth2/token/status

Add the access token to the Authorization header of the request.

Important: The Authorization header you provide to this endpoint must have the following format:

Authorization: Bearer ACCESS_TOKEN

where ACCESS_TOKEN is a valid production authorization credential.

If the access token is expired or not a valid access token, the endpoint returns an UNAUTHORIZED error.

Guide

Token Introspection

Try in API Explorer
Link to section

Response fields

Link to section

scopes

string [ ]

The list of scopes associated with an access token.

Link to section

expires_at

string

The date and time when the access_token expires, in RFC 3339 format. Empty if the token never expires.

Link to section

client_id

string

The Square-issued application ID associated with the access token. This is the same application ID used to obtain the token.

Max Length
191
Link to section

merchant_id

string

The ID of the authorizing merchant's business.

Min Length
8
Max Length
191
Link to section

errors

Any errors that occurred during the request.