Get a customer

curl --request GET \
  --url https://api.codaclean.io/v1/customers/{customerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.codaclean.io/v1/customers/{customerId}"

headers = {
    "x-api-key": "<api-key>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-api-key': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('https://api.codaclean.io/v1/customers/{customerId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

using RestSharp;


var options = new RestClientOptions("https://api.codaclean.io/v1/customers/{customerId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-api-key", "<api-key>");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "id": "675b4183d350b74dad2f46ec",
  "enterpriseNumber": "0764.042.472",
  "name": "Boulangerie Dupont SRL",
  "accountingRef": "DUPONT",
  "address": {
    "street": "Rue du Marché 12",
    "street2": "",
    "zipCode": "1000",
    "municipality": "Bruxelles",
    "country": "Belgique"
  },
  "contact": {
    "name": "Marie Dupont",
    "function": "CEO",
    "email": "marie.dupont@example.com",
    "language": "nl"
  },
  "isConfidential": false,
  "bankAccounts": [
    {
      "iban": "BE49001163522171",
      "currency": "EUR",
      "bic": "GEBA BE BB",
      "bankName": "BNP Paribas Fortis"
    },
    {
      "iban": "BE68001466139034",
      "currency": "EUR",
      "bic": "GEBA BE BB",
      "bankName": "BNP Paribas Fortis"
    },
    {
      "iban": "BE40751680738663",
      "currency": "EUR",
      "bic": "AXAB BE 22",
      "bankName": "Crelan"
    },
    {
      "iban": "BE10732141110904",
      "currency": "EUR",
      "bic": "CREG BE BB",
      "bankName": "CBC Banque et Assurances"
    },
    {
      "iban": "BE79104034016533",
      "currency": "EUR",
      "bic": "NICA BE BB",
      "bankName": "Crelan"
    },
    {
      "iban": "BE21103265210903",
      "currency": "EUR",
      "bic": "NICA BE BB",
      "bankName": "Crelan"
    }
  ],
  "payrollProviders": [
    {
      "code": "sdworx",
      "nameFr": "SD Worx",
      "nameNl": "SD Worx"
    },
    {
      "code": "twinntax",
      "nameFr": "TwinnTax",
      "nameNl": "TwinnTax"
    }
  ],
  "createdOn": "2024-12-12T20:03:15.277Z",
  "updatedOn": "2026-06-30T10:30:16.368Z"
}

GET

customers

{customerId}

Get a customer

curl --request GET \
  --url https://api.codaclean.io/v1/customers/{customerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.codaclean.io/v1/customers/{customerId}"

headers = {
    "x-api-key": "<api-key>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-api-key': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('https://api.codaclean.io/v1/customers/{customerId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

using RestSharp;


var options = new RestClientOptions("https://api.codaclean.io/v1/customers/{customerId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-api-key", "<api-key>");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "id": "675b4183d350b74dad2f46ec",
  "enterpriseNumber": "0764.042.472",
  "name": "Boulangerie Dupont SRL",
  "accountingRef": "DUPONT",
  "address": {
    "street": "Rue du Marché 12",
    "street2": "",
    "zipCode": "1000",
    "municipality": "Bruxelles",
    "country": "Belgique"
  },
  "contact": {
    "name": "Marie Dupont",
    "function": "CEO",
    "email": "marie.dupont@example.com",
    "language": "nl"
  },
  "isConfidential": false,
  "bankAccounts": [
    {
      "iban": "BE49001163522171",
      "currency": "EUR",
      "bic": "GEBA BE BB",
      "bankName": "BNP Paribas Fortis"
    },
    {
      "iban": "BE68001466139034",
      "currency": "EUR",
      "bic": "GEBA BE BB",
      "bankName": "BNP Paribas Fortis"
    },
    {
      "iban": "BE40751680738663",
      "currency": "EUR",
      "bic": "AXAB BE 22",
      "bankName": "Crelan"
    },
    {
      "iban": "BE10732141110904",
      "currency": "EUR",
      "bic": "CREG BE BB",
      "bankName": "CBC Banque et Assurances"
    },
    {
      "iban": "BE79104034016533",
      "currency": "EUR",
      "bic": "NICA BE BB",
      "bankName": "Crelan"
    },
    {
      "iban": "BE21103265210903",
      "currency": "EUR",
      "bic": "NICA BE BB",
      "bankName": "Crelan"
    }
  ],
  "payrollProviders": [
    {
      "code": "sdworx",
      "nameFr": "SD Worx",
      "nameNl": "SD Worx"
    },
    {
      "code": "twinntax",
      "nameFr": "TwinnTax",
      "nameNl": "TwinnTax"
    }
  ],
  "createdOn": "2024-12-12T20:03:15.277Z",
  "updatedOn": "2026-06-30T10:30:16.368Z"
}

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.

Path Parameters

customerId

string

required

Customer identifier (24-character hexadecimal string), as returned in id.

Response

The customer.

Fields without a value are omitted from the response. Arrays are always present.

string

enterpriseNumber

string

Belgian enterprise number, formatted 0123.456.789.

name

string

accountingRef

string

address

object

Show child attributes

contact

object

Contact person at the customer. Mandate signature requests are sent to this contact.

Show child attributes

isConfidential

boolean

Confidential customers are only visible to users with the Administrator access level.

bankAccounts

object[]

Active bank accounts only.

Show child attributes

payrollProviders

object[]

Active payroll providers only.

Show child attributes

createdOn

string<date-time>

updatedOn

string<date-time>

Get started

Concepts

Guides

Authentication

Utilities

Customers

Bank accounts

Customer payroll providers

Mandates

Reference data

CODA files

CODB files

Get a customer

Authorizations

Path Parameters

Response