Response Codes
HTTP Response Codes
A summary of HTTP Response Codes returned by the VeriDoc Global API is listed below.
| HTTP Code | Summary | Description |
|---|---|---|
| 200 | OK | Successful API call. |
| 400 | Bad Request | A validation exception has occurred. |
| 404 | Not Found | The resource you have specified cannot be found. |
| 412 | Precondition Failed | One or more conditions given in the request header fields were invalid. |
| 500 | Internal Error | There was an unhandled error with the VeriDoc Global API. Contact the VeriDoc Global API team if problems persist |
| 501 | Not Implemented | The method you have called has not been implemented (e.g. POST Organisation) |
| 503 | Rate Limit Exceeded | The API rate limit for your organisation/application pairing has been exceeded. |
| 503 | Not Available | API is currently unavailable - typically due to a scheduled outage - try again soon. |
| 503 | Organisation offline | The organisation cannot be connected to at this time. |
VeriDoc Global Response Codes
A summary of Response Codes returned by the VeriDoc Global API is listed below.
| Return Code | Summary | Description |
|---|---|---|
| 1 | Request Successfully executed | This code is returned when the parameters are passed successfully. |
| 2,3,4.. | Authorization failed or parameters are missing/empty | If the code returns any other number other than 1, it means the parameters are either empty/missing or authorization failed. |