Skip to main content
This page takes you from zero to a first successful call. You need an API key issued by Codaclean and a Codaclean user account. User accounts are created and managed by the accounting firm in MyCodaclean. See also: Authentication
1

Get an API key

Codaclean issues one API key per partner software.It identifies your software, not a specific accounting firm: the same key serves all the firms that use your software.

Request API access

Contact Codaclean to get an API key.
2

Get an ID token

Call POST /token with the user’s Codaclean username and their password encoded in Base64. Send your API key in the x-api-key header.The response contains an idToken and a refreshToken.See also: Authentication
3

Make your first call

Call GET /hello with both headers:A 200 response confirms that both credentials are accepted.
4

Pick your use case

Download CODA files

List new bank statements, download them, and acknowledge them.

Download CODB files

Same flow for payroll files.

Onboard a customer

Create a customer and request its mandates.

Upload files

Send CODA or CODB files to Codaclean.

​
Base URLs

See also: Environments