Response Codes | Sign In App User Guide

The following is a list of response codes that could be issued by the Sign In App API endpoints. Where possible each endpoint documents specific parameter requirements and possible errors specific to that endpoint.

200 OK

This is returned for most other successful API calls including GET, PUT, PATCH and DELETE. The returned data will represent the requested resource.

201 Created

This is returned when a new resource on the API is created. 201 is returned as a confirmation that the resource call was successful. Usually the response contains the newly created entity.

401 Unauthorized

The API credentials being used either do not exist or failed to authenticate. Check the authentication header is set correctly and with the correct details.

403 Forbidden

A permissions check for the specified endpoint failed for the API client being used. Check in the portal for the associated permissions for the client being used.

405 Method Not Allowed

This is often due to the endpoint not accepting the specified HTTP verb. Check the documentation for that endpoint and it's supported HTTP methods.

422 Unprocessable Entity

When validation on fields provided in a request fail, a JSON object with each field that failed is returned with a description of the reason.

Object {
  String <key>: Array[String]
}

Example

{
  "name": [
    "Name is a required field."
  ],
  "mobile": [
    "The specified mobile number is not valid."
  ]
}

429 Too Many Requests

Sign In App API implements throttling on all endpoints. Make sure to limit the number of requests to a maximum of 20 per minute. If this is exceeded then this response will be returned until the minute expires.

500 Internal Server Error

If a problem occurs during execution which can not be returned as a useful error message the Sign In App API will return this status. Internal systems are setup to monitor these errors and response appropriately.

503 Service Unavailable

Occasionally we perform maintenance that may require a minimal amount of downtime. This status is issued during that period. Requests should be queued and retried at a later time.