Issue an access token

Exchanges integrator client credentials for a bearer access token. No bearer token required (you don’t have one yet), but x-zeam-auth is still required — every request needs it.

POST /auth/token

Issue an access token

cURL

curl --request POST \
  --url https://api.zeam.money/gw/v1/auth/token \
  --header 'Content-Type: application/json' \
  --header 'x-zeam-auth: <api-key>' \
  --data '
{
  "clientId": "11111111-1111-1111-1111-111111111111",
  "clientSecret": "s3cr3t-value"
}
'

200

{
  "accessToken": "eyJ0eXAiOiJKV1Qi...",
  "tokenType": "Bearer",
  "expiresIn": 3599,
  "associationId": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}

Authorizations

x-zeam-auth · string · header · required

Application secret (the apiKey issued at registration), required on every request.

Body

application/json

clientId · string<uuid> · required

clientSecret · string · required

Response

200

application/json

Token issued.

accessToken · string · required

tokenType · string · required

Example:

"Bearer"

expiresIn · integer · required

Seconds until expiry

Example:

3599

associationId · string<uuid> · required

Zeam association the credentials map to.