Skip to main content

Intro

Welcome to the Customaite API documentation! Customaite is an application which allows customs declarants to easily prepare customs declarations, with the help of AI.

We provide APIs so that customers and their service providers can

  • create dossiers on our platform
  • receive published dossiers (see: webhooks)
  • upload master data (parties, goods locations, product data ...)

If you have any questions, we're happy to provide support via your customer success manager.

General notes​

Authentication​

All requests expect an API key provided via the adore-subscription-key header.

For example:

curl --location 'https://api.customaite.ai/instructions' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'adore-subscription-key: REPLACEME' \
--data '{
"externalReference": "testexportdossier",
"title": "Test export dossier",
"activityType": “EXPORT”,
}’

Backwards-compatibility​

We may provide backwards-compatible updates to the APIs. This means we may add fields to contracts (such as Declaration) or enums. For this reason, the contract will specify enum type fields as string and add the (current) possible values in the description. If you use code generators for the APIs, we recommend to disable raising errors if there are unknown properties provided.

In Java, using Jackson, this can be achieved with settings such as

@JsonIgnoreProperties(ignoreUnknown = true)

Versioning​

The version number of the Customaite API will be increased as follows:

  • Major (1.x.x): Breaking changes such as API removals or new versions of APIs
  • Minor (x.1.x): New APIs added or new fields added to existing APIs
  • Patch (x.x.1): Documentation updates of APIs

In the case of a Major version increase, migration guidelines and timelines will be communicated in advance.