Get or refresh a token

curl --request POST \
  --url https://api.codaclean.io/v1/token \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "username": "user@example.com",
  "password": "TXlQQHNzdzByZA=="
}
'

{
  "idToken": "eyJraWQiOiJFWEFNUExFIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiIwMDAwMDAwMC0wMDAwLTQwMDAtODAwMC0wMDAwMDAwMDAwMDEifQ.EXAMPLE_SIGNATURE",
  "refreshToken": "eyJjdHkiOiJKV1QiLCJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAifQ.EXAMPLE_REFRESH_TOKEN"
}

POST

token

curl --request POST \
  --url https://api.codaclean.io/v1/token \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "username": "user@example.com",
  "password": "TXlQQHNzdzByZA=="
}
'

{
  "idToken": "eyJraWQiOiJFWEFNUExFIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiIwMDAwMDAwMC0wMDAwLTQwMDAtODAwMC0wMDAwMDAwMDAwMDEifQ.EXAMPLE_SIGNATURE",
  "refreshToken": "eyJjdHkiOiJKV1QiLCJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAifQ.EXAMPLE_REFRESH_TOKEN"
}

Authorizations

x-api-key

string

header

required

Identifies the partner software. Issued by Codaclean. Required on every call, including POST /token.

Body

application/json

Username and password
Refresh token

username

string

required

The user's Codaclean login.

password

string

required

The user's password, Base64-encoded.

Response

Token issued.

idToken

string

Send it as Authorization: Bearer <idToken> on every other call. Valid for 1 hour.

refreshToken

string

Valid for 30 days. Returned on a username/password login only; absent from the response to a refresh.

Get started

Concepts

Guides

Authentication

Utilities

Customers

Bank accounts

Customer payroll providers

Mandates

Reference data

CODA files

CODB files

Authorizations

Body

Response