List banks

curl --request POST \
  --url https://api.codaclean.io/v1/banks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "bic": "GEBA BE BB"
}
'

{
  "records": [
    {
      "name": "BNP Paribas Fortis",
      "country": "BE",
      "bicCodes": [
        "GEBA BE BB"
      ],
      "available": true
    }
  ],
  "recordsTotal": 1980,
  "recordsFiltered": 1
}

POST

banks

curl --request POST \
  --url https://api.codaclean.io/v1/banks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "bic": "GEBA BE BB"
}
'

{
  "records": [
    {
      "name": "BNP Paribas Fortis",
      "country": "BE",
      "bicCodes": [
        "GEBA BE BB"
      ],
      "available": true
    }
  ],
  "recordsTotal": 1980,
  "recordsFiltered": 1
}

Authorizations

x-api-key

string

header

required

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

Authorization

string

header

required

Identifies the user and their accounting firm. Send the idToken returned by POST /token as Authorization: Bearer <idToken>. Valid for 1 hour.

Body

application/json

bic

string

Spaces are ignored.

country

string

Country code, case-insensitive.

available

boolean

limit

integer

default:50

Required range: x <= 200

offset

integer

default:0

Response

Matching banks.

records

object[]

Show child attributes

recordsTotal

integer

recordsFiltered

integer

Get started

Concepts

Guides

Authentication

Utilities

Customers

Bank accounts

Customer payroll providers

Mandates

Reference data

CODA files

CODB files

Authorizations

Body

Response