Get a widget access token

Create an ephemeral (short-term, limited-scope) access token for interacting with a card via Synctera widgets.

GET /cards/{card_id}/widget_token

Get a widget access token

cURL

curl --request GET \
  --url https://api.synctera.com/v2/cards/{card_id}/widget_token \
  --header 'Authorization: Bearer <token>'

200

{
  "tenant": "abcdef_ghijkl",
  "widget_token": "0b0319e2-d5f4-49cb-b426-9ff9b2e96969"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key · string

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Query Parameters

card_id · string<uuid>

Card ID

Example:

"6dc0397d-1aba-4be9-9582-895a7a887d49"

widget_type · enum<string> · required

Available options: SET_PIN, GET_PIN, ACTIVATE, REVEAL

Response

200

application/json

Client token

tenant · string · required

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

Example:

"abcdef_ghijkl"

widget_token · string · required

A short-lived, one-time token for use with Synctera widgets

Example:

"0b0319e2-d5f4-49cb-b426-9ff9b2e96969"