Response Structure

All POST request parameters as application/json parameters, responses from the API are always JSON.

Successful Response

{
  "message": "Please enter OTP",
  "status": "success",
  "data": {}
}

All responses coming from the API server are JSON with the content-type application/json unless explicitly stated otherwise. A successful 200 OK response always has a JSON response body with a status key with the value success. The data key contains the full response payload.

Failed Response

{
  "message": "Incorrect Client ID or Password. Attempt 1 of 3",
  "status": "failed",
  "code": "400"
}

The status key in the response envelope contains the value failed. The error code contains the error-code of the error or exception and the message key contains a textual description of the error.

Header Parameters

Each and every post method must contain the headers as below table.