API Response Guide

This page lists the most common responses that you or your system may receive from the API in order to assist your understanding and assist your development process.

Please contact the team if you are seeing a response that you cannot understand or were not expecting.

Note: Generic response code information is supplemented by IQumulate-specific advice in blue.

Response Code

Response Description

Comments

2xx

Success Codes (2xx)

  • 200 OK:

    The request was successful, and the response body contains the requested data.

  • 201 Created:

    The request was successful, and a new resource was created on the server. The response body might contain a representation of the new resource. 

  • 204 No Content:

    The request was successful, but there is no content to return in the response body. This is common for successful PUT or DELETE operations.

3xx

Redirection Codes (3xx)

  • 301 Moved Permanently:

    The requested resource has been permanently moved to a new location.

  • 302 Found:

    The requested resource has been temporarily moved to a different URI.

4xx

Client Error Codes (4xx)

  • 400 Bad Request:

  • The server could not understand the request due to invalid syntax or other client-side errors (e.g., missing headers, invalid parameters).

  • 401 Unauthorized:

    The client must authenticate itself to get the requested response. This often means missing or invalid authentication credentials. 

  • 403 Forbidden:

    The client does not have access rights to the content, even if authenticated. 

    Contact IQumulate for help if you believe you should have or need to obtain access to this endpoint.

  • 404 Not Found:

    The server cannot find the requested resource.

    The data was not found (for instance a contact, quote or loan reference was not correct); OR
    contact, quote or loan data being requested does not belong to the broker code/s that your user has access to.

  • 409 Conflict:

    The request conflicts with the current state of the server or resource (e.g., trying to create a resource that already exists).

  • 429 Too Many Requests:

    The client has sent too many requests in a given amount of time, often due to rate limiting policies in APIM.

5xx

Server Error Codes (5xx)

  • 500 Internal Server Error:

    A generic error message indicating that an unexpected condition was encountered on the server, preventing it from fulfilling the request. This can originate from the backend API or APIM itself.

  • 502 Bad Gateway:

    The server, while acting as a gateway or proxy, received an invalid response from an upstream server.

  • 503 Service Unavailable:

    The server is currently unable to handle the request due to temporary overload or maintenance.

  • 504 Gateway Timeout:

    The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server.

☰