Skip to content

Overview

Errors

The standard response body format for errors in our API follows RFC 7807.

Here is an example:

HTTP/2 400 Bad Request
Content-Type: application/problem+json
Content-Language: en

{
    "type": "about:blank",
    "title": "Constraint Violation",
    "status": 400,
    "detail": "Request body contains one or more errors",
    "instance": "urn:bisnode:traceid:f3f9d15f-fe66-4d2f-b0d3-8aa4a84bac1e",
    "violations": [
        {
            "field": "name",
            "reason": "must not be null"
        },
        {
            "field": "url",
            "reason": "must use https protocol"
        }
    ]
}

Note

violations is an additional property to the error model. Additional properties may be added for some errors (such as violations for validation errors), see the API specification for a detailed description of possible errors.

For more information see the Custom Problem Details: