Getting started with the DQE API

This guide walks you through the steps to make your first DQE API call — from obtaining credentials to calling a service endpoint.

Prerequisites

• A valid DQE licence code and client secret (provided by DQE)
• An HTTP client or your own application code

Step 1 — Authenticate with OAuth2

DQE APIs use OAuth2 Bearer token authentication. Before calling any service, request a token:

1. Call the OAuth2 endpoint with your licence code, client secret, and the scope of the service you want to access.
2. Read the access token returned in the JSON response.
3. Include it as a Bearer token in the Authorization header of your API requests.

Tokens are valid for a limited period — generate a new one before it expires.

See full OAuth2 documentation →

Step 2 — Call a service endpoint

DQE APIs support both GET and POST methods. Responses are always returned in JSON format.

For some services, the country parameter is mandatory and must use the ISO 3166-1 alpha-3 country code (e.g. FRA for France, GBR for the United Kingdom).

Browse all API endpoints →

Step 3 — Test with Swagger

DQE provides a Swagger interface to explore and test API endpoints without writing code. It is the fastest way to understand request parameters and response formats before starting your integration.

Access the Swagger documentation →

Important notes

• DQE APIs are designed for real-time, single-record calls. Do not use them for batch processing — use file-based batch processing for bulk operations.
• Implementing API calls in blocking mode is at the client's sole responsibility. DQE recommends thorough testing before production deployment.

Related articles

• API — How it works
• API — Authentication
• Best practices for integrating DQE APIs