Error Handling

Error Handling

What error codes are there and how to handle errors.

Success and Error codes

Each API request will return a response. A successful request will typically return a 200 OK status code along with any requested data. Errors or issues with your request will return different status codes (e.g., 400 Bad Request, 401 Unauthorized) and an error message explaining what went wrong.

Success Codes

Comment

Code	Description
200	OK - The request has succeeded.
201	Created - The request has been fulfilled and has resulted in one or more new resources being created.
202	Accepted - The request has been accepted for processing, but the processing has not been completed.
204	No Content - The server successfully processed the request, but is not returning any content.
303	Redirect - Provides redirections to another resource.

Error codes

Code	Description
400	Bad Request - The server cannot process the request due to a client error (e.g., malformed request syntax).
401	Unauthorised - The request lacks valid authentication credentials for the target resource.
404	Not Found - The server can't find the requested resource.
408	Request timeout
500	Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request.
502	Bad gateway
504	Gateway timeout

Error Message Standard

Error handling for all API methods must adhere to the RFC7807 standard, ensuring standardized and informative error responses for clients. Please see https://www.rfc-editor.org/rfc/rfc7807. Please see below of a standard example.

Example:

{
    "ValidationErrors": {
        "Profile.FirstName": [
            "FirstName: field is required"
        ],
        "Profile.CurrentAddress.Structured.CountryCode": [
            "CountryCode: field is required"
        ]
    },
    "Type": null,
    "Title": "Request Validation Error",
    "Status": 400,
    "Detail": "One or more validation errors occurred. See ValidationErrors for details.",
    "Instance": "urn:tillertechverifications:badrequest:43f3e884-c791-4c39-a05d-351d8ed162b6",
    "Extensions": {}
}