Skip to main content
GET
/
fdx_tokens
/
{fdx_token_id}
Get an FDX token
curl --request GET \
  --url https://api.synctera.com/v2/fdx_tokens/{fdx_token_id}
{
  "creation_time": "2010-05-06T12:23:34.321Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "status": "ENABLED",
  "tenant": "abcdef_ghijkl",
  "token_expiry_time": "2010-05-06T12:23:34.321Z",
  "token_hash": "<string>",
  "token_type": "ACCESS",
  "business_id": "<string>",
  "customer_id": "<string>",
  "parent_token_id": "<string>"
}

Path Parameters

​
fdx_token_id
string<uuid>
required

The unique identifier of an FDX token

Response

FDX token

​
creation_time
string<date-time>
required

The date and time the token was created.

Example:

"2010-05-06T12:23:34.321Z"

​
id
string<uuid>
required

FDX token ID

​
last_updated_time
string<date-time>
required

The date and time the token was last updated.

Example:

"2010-05-06T12:23:34.321Z"

​
status
enum<string>
required

The status of the FDX token. When ENABLED, check token_expiry_time to determine if it has expired. Refresh tokens automatically transition to USED when they are used to create a new token, and cannot be used again.

Available options:
ENABLED,
REVOKED,
USED
​
tenant
string
required

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example:

"abcdef_ghijkl"

​
token_expiry_time
string<date-time>
required

The date and time the token expires.

Example:

"2010-05-06T12:23:34.321Z"

​
token_hash
string
required

The non-secret hash of the FDX token.

​
token_type
enum<string>
required

The type of the FDX token.

Available options:
ACCESS,
REFRESH
​
business_id
string

The UUID of the business associated with the FDX token. One of customer_id or business_id must be provided.

​
customer_id
string

The UUID of the customer associated with the FDX token. One of customer_id or business_id must be provided.

​
parent_token_id
string

If the token was created via refresh, this is the ID of the refreshing token.