Digicust Public API

We allow our customers and partners to fully integrate with our services. The Digicust API is extensive, well-documented, and easy to get started with.

Prerequisites

• You have an active customer account

• You have a user account with email-password authentication

• Your execution strategy is properly set up. An execution strategy defines how customs cases are being processed. You can manage your execution strategies in our web app.

If you do not fulfill the above prerequisites, please create a new account with https://app.digicust.com/

Authentication

You need an access token for all requests. Fetch your access token with the following CURL:

curl -X 'POST' \
  'https://api.digicust.com/generic/api/auth/authenticate' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "username": "<YOUR USERNAME>",
  "password": "<YOUR PASSWORD>"
}'

For more details: https://api.digicust.com/generic/api-docs/#/Auth/post_api_auth_authenticate

Documentation

Find detailed documentation on available endpoints here:

Example: Uploading a Case

The API for file uploads is documented here: https://api.digicust.com/upload/api-docs/

Use the access token fetched earlier.

curl -X 'POST' \
  'https://api.digicust.com/upload/api/<YOUR CUSTOMER ID>/<YOUR PROJECT ID>/new' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <YOUR ACCESSTOKEN>' \
  -H 'Content-Type: multipart/form-data' \
  -F 'executionStrategyId=<YOUR EXECUTION STRATEGY>' \
  -F 'moduleType=' \
  -F 'classification=invoice' \
  -F 'flags={}' \
  -F 'moduleCategory=' \
  -F 'reference=test upload' \
  -F 'queueId=' \
  -F 'classifications=' \
  -F 'files=@5257523013391441-1r202007d02zix94.pdf;type=application/pdf'

This will return a newly initiated case. Use its id for further reference. The case will automatically be processed.

Example: Fetch a Case

You can use the id returned by the previous example to fetch a case using the following request:

curl -X 'GET' \
  'https://api.digicust.com/generic/api/<YOUR CUSTOMER ID>/<YOUR PROJECT ID>/cases/<YOUR CASE ID>' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <YOUR ACCESS TOKEN>'

This case will give you among all other case information a status.value. This indicates the processing state of the customs case. A finished customs case will always have status processed.

Support

Our team is happy to support you in integrating with our services.

support@digicust.com

or

https://digicust.com/contact/