Introduction

The Didomi platform offers a standard REST API that you can use to manage all aspects of the platform. Its base URL is: https://api.didomi.io/v1/.

Our API uses standard HTTP verbs (GET, POST, etc.) to retrieve or modify resources and standard HTTP error codes (4xx and 5xx) to communicate errors when they happen with detailed error information in the body. All standard HTTP clients are able to talk to our API without modifications. The API always responds in JSON, including for errors. The only exception are routes that also support different formats like reports. In that case, JSON is the default format unless otherwise specified and additional response formats can be specified in the request.

This section will guide you through setting up an API client and using the main resources exposed by our API. You will also want to consult our complete API specification (https://api.didomi.io/docs/) as a reference when using our API.

You will need an API key and secret to call our API. If you do not have an API key yet, reach out to support@didomi.io.

Topics

• ​Introduction: Setup your environment for using the Didomi API and learn about standard topics like authentication, errors and pagination.

  • ​Authentication​

  • ​Errors​

  • ​Pagination​

• ​Consents and Preferences: Manage user consent information

  • ​Events​

  • ​Tokens​

  • ​Users​

• ​Monitoring and reporting: Schedule, execute and download compliance reports

  • ​Excel format reference​

  • ​Reports​

  • ​Websites​

​