All API endpoints contain a code and message within the error responses, though some API endpoints extend the error object to contain other information. Each endpoint that does this will be documented in their appropriate section.
While we recommend that you write error messages that fit your needs and provide your users with the best experience, our message fields are designed to be neutral, not contain sensitive information, and can be safely passed down to user interfaces.
{
"error": {
"code": "bad_request",
"message": "An english description of the error that just occurred"
}
}
Certifier API supports the following codes:
| HTTP status code | Certifier code | Description |
|---|---|---|
| 400 | missing_version | The request is missing the required Certifier-Version header. See versioning. |
| 400 | invalid_version | The Certifier-Version header's value is invalid. See versioning. |
| 400 | invalid_json | The request body can not be decoded as JSON. |
| 400 | validation_error | This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. |
| 401 | unauthorized | A valid authentication token was not provided with the request, so the API could not associate a user with the request. |
| 402 | payment_required | The request was valid, but the queried object or object mutation specified in the request is only available to premium organizations and workspaces. |
| 403 | forbidden | The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. |
| 404 | not_found | Either the request method and path supplied do not specify a known action in the API, or the object specified by the request does not exist. |
| 409 | conflict | The request could not be completed, potentially due to a data collision. Make sure the parameters are up to date and try again. |
| 429 | rate_limited | You have exceeded one of the enforced rate limits in the API. See the documentation on rate limiting for more information. |
| 500, 502, 503, 504 | internal_server_error | There was a problem on Certifier's end. |
New codes and message property
In the future, Certifier may add some new codes. We advise you to rely on the Certifier's
codeproperty rather than on HTTP status only to distinguish between errors. Also, we recommend you not to write code that relies on themessageproperty heavily since it could change in the future.