FI Token

Issues a FI-level Bearer token using the client credentials grant. Use this token for institution-level operations that do not require a member context.

POST /auth/v1/token

FI Token

cURL

curl --request POST \
  --url https://api.candescent.com/auth/v1/token \
  --header 'Content-Type: application/json' \
  --data '
{
  "grant_type": "client_credentials",
  "client_id": "<string>",
  "client_secret": "<string>",
  "scope": "account:read institution-users:read",
  "username": "<string>",
  "password": "<string>"
}
'

200

{
  "access_token": "<string>",
  "token_type": "Bearer",
  "expires_in": 123,
  "scope": "<string>"
}

Body

application/json

grant_type · string · required

OAuth 2.0 grant type (client_credentials or password)

Example:

"client_credentials"

client_id · string · required

OAuth 2.0 client ID

client_secret · string · required

OAuth 2.0 client secret

scope · string

Space-separated list of requested scopes

Example:

"account:read institution-users:read"

username · string

Member username (required for password grant)

password · string

Member password (required for password grant)

Response

200

application/json

Token issued successfully

access_token · string

Bearer token to include in all subsequent API requests

token_type · string

Example:

"Bearer"

expires_in · integer

Token lifetime in seconds

scope · string

Granted scopes