API
Errors
The Didomi API uses standard HTTP response codes to indicate that an API request is a success or a failure. In general, the codes act as follows:
2xxcodes indicate a success4xxcodes indicate an error in the parameters sent to the server (e.g., the authentication information is invalid, a required parameter is missing, etc.)5xxcodes indicate a Didomi server-side error (it should not happen, but hey, we are human too!)
When an error happens, you can look at the JSON response body to find more about the reason. The body will be an object with the following properties:
Property
Description
Example
codeThe HTTP response code
400
nameThe name of the error (tied to the response code)
BadRequest
messageAn explanation of the error
Invalid authentication information
errorsAn array containing more errors if multiple errors have been batched together
Example:
1
{
2
"code": 400,
3
"errors": {},
4
"message": "Invalid authentication information",
5
"name": "BadRequest"
6
}
Copied!
Last modified 4mo ago
Copy link