# Codaclean API

> Integrate Codaclean into your software: customers, CODA and CODB mandates, and CODA/CODB file retrieval.

## API reference

### Get started

- [Codaclean API](https://docs.codaclean.io/api/introduction.md): Connect your software to Codaclean: manage customers, request CODA and CODB mandates, and retrieve bank and payroll files.
- [Quickstart](https://docs.codaclean.io/api/quickstart.md): Get your credentials, obtain an ID token, and make your first call to the Codaclean API.
- [Authentication](https://docs.codaclean.io/api/authentication.md): Every call carries an API key that identifies your software and an ID token that identifies the user.
- [Environments](https://docs.codaclean.io/api/environments.md): Production and staging base URLs of the Codaclean API.

### Concepts

- [Scopes](https://docs.codaclean.io/api/scopes.md): Scopes define what your API key is allowed to do.
- [Data access](https://docs.codaclean.io/api/data-access.md): Which customers, mandates and files a user can see through the API.
- [Pagination and filters](https://docs.codaclean.io/api/pagination.md): How list endpoints take filters and return pages of results.
- [Errors](https://docs.codaclean.io/api/errors.md): Error format, HTTP status codes and error codes returned by the Codaclean API.
- [Rate limits](https://docs.codaclean.io/api/rate-limits.md): Default request limits per API key.

### Guides

- [Download CODA files](https://docs.codaclean.io/api/guides/sync-coda-files.md): List new bank statement files, download them, and acknowledge each download.
- [Download CODB files](https://docs.codaclean.io/api/guides/sync-codb-files.md): List new payroll files, download them, and acknowledge each download.
- [Onboard a customer](https://docs.codaclean.io/api/guides/onboard-customer.md): Create a customer, link its bank accounts and payroll providers, request mandates, and follow them until they are active.
- [Upload files](https://docs.codaclean.io/api/guides/upload-files.md): Get temporary credentials and upload CODA or CODB files to Codaclean.

### Authentication

- [Get or refresh a token](https://docs.codaclean.io/api/endpoints/get-token.md): Exchange the user's credentials for an ID token.

### Utilities

- [Hello world](https://docs.codaclean.io/api/endpoints/hello.md): Checks that your API key and ID token are accepted.

### Customers

- [Search customers](https://docs.codaclean.io/api/endpoints/search-customers.md): Paginated, filterable list of the customers visible to the user, sorted by name.
- [List all customers](https://docs.codaclean.io/api/endpoints/list-all-customers.md): Returns every customer visible to the user, as a plain array, without pagination.
- [Get a customer](https://docs.codaclean.io/api/endpoints/get-customer.md): **Required scope:** `customers:read`
- [Create a customer](https://docs.codaclean.io/api/endpoints/create-customer.md): Creates a customer.
- [Update a customer](https://docs.codaclean.io/api/endpoints/update-customer.md): Updates only the fields sent.
- [Archive a customer](https://docs.codaclean.io/api/endpoints/archive-customer.md): Archives the customer and its mandate requests.

### Bank accounts

- [Add a bank account](https://docs.codaclean.io/api/endpoints/add-bank-account.md): Links the IBAN to the customer.
- [Disable a bank account](https://docs.codaclean.io/api/endpoints/disable-bank-account.md): Disables the bank account on the customer.

### Customer payroll providers

- [Add a payroll provider](https://docs.codaclean.io/api/endpoints/add-payroll-provider.md): Links the payroll provider to the customer.
- [Remove a payroll provider](https://docs.codaclean.io/api/endpoints/remove-payroll-provider.md): Unlinks the payroll provider from the customer.

### Mandates

- [Search mandates](https://docs.codaclean.io/api/endpoints/search-mandates.md): Paginated, filterable list of mandates.
- [Get a mandate](https://docs.codaclean.io/api/endpoints/get-mandate.md): **Required scope:** `mandates:read`
- [Request a CODA mandate](https://docs.codaclean.io/api/endpoints/request-coda-mandate.md): Requests a mandate for the bank account.
- [Request a CODB mandate](https://docs.codaclean.io/api/endpoints/request-codb-mandate.md): Requests a CODB mandate for a payroll provider linked to the customer.

### Reference data

- [List banks](https://docs.codaclean.io/api/endpoints/list-banks.md): Banks for which Codaclean can request a mandate: CODA banks, and banks reachable through a CODAlight connector.
- [List payroll providers](https://docs.codaclean.io/api/endpoints/list-payroll-providers.md): Payroll providers (social secretariats) known to Codaclean, sorted by code.

### CODA files

- [List CODA files](https://docs.codaclean.io/api/endpoints/list-coda-files.md): Processed CODA files, grouped by customer, then by IBAN, currency and year.
- [Acknowledge a CODA file](https://docs.codaclean.io/api/endpoints/acknowledge-coda-file.md): Confirms that you downloaded the file.
- [Get CODA upload credentials](https://docs.codaclean.io/api/endpoints/coda-upload-credentials.md): Returns temporary AWS credentials to upload CODA files to Codaclean's S3 bucket, under the returned `prefix` only.

### CODB files

- [List CODB files](https://docs.codaclean.io/api/endpoints/list-codb-files.md): Processed CODB files, grouped by customer, then by payroll provider and year.
- [Acknowledge a CODB file](https://docs.codaclean.io/api/endpoints/acknowledge-codb-file.md): Confirms that you downloaded the file.
- [Get CODB upload credentials](https://docs.codaclean.io/api/endpoints/codb-upload-credentials.md): Returns temporary AWS credentials to upload CODB files to Codaclean's S3 bucket, under the returned `prefix` only.

## OpenAPI Specs

- [openapi](/openapi.yaml)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [French (37 pages)](https://docs.codaclean.io/_llms/fr.md): Documentation for French.
- [Dutch (37 pages)](https://docs.codaclean.io/_llms/nl.md): Documentation for Dutch.