HTTP Response Codes
IDMERIT returns a standardized status codes in responses to client's requests made to our API endpoints. These codes convey important information about the outcome of the request, indicating whether it was a successful, encountered an error, or requires further action from the client.
Success Codes
200 - OK
Error Codes
400 - Bad Request
The request could not be understood by the server. Please ensure that the request is in the appropriate format and all the necessary headers have been included.
401 - Unauthorized
The request is legal, but authorization token is not valid or is expired. Please make sure you use the valid token while submitting payload request.
403 - Forbidden
The request was valid, but the requestor does not have the permission to access the requested resource. Please ensure that you're using the correct username and submitted access token is still valid. If your access token has expired, you may need to reauthenticate your credentials to get a new token.
405 - Method Not Allowed
Request call was made using an incorrect request method. Please make sure you use a valid method while calling API.
429 - Too Many Requests
500 - Internal Server Error
502 - Bad Gateway
503 - Service Unavailable
504 - Gateway Timeout Error
Handling HTTP Response Codes in API Clients
API clients should be designed to handle different HTTP response codes gracefully to provide a smooth and experience and to handle errors effectively. Below are some of the best practices for handling response codes:
Check Response Status: Always check the HTTP status code returned by the server to determine the outcome of the request.
Handling Errors: Implement error handling logic to handle common client and server errors gracefully.
Retry Mechanism: Implement retry mechanisms for transient errors, such as server timeouts or temporary network issues, to improve the reliability of the API calls.
Last updated
Was this helpful?