HTTP status codes
The following table lists the HTTP status codes and which API calls use these codes.
| Code | Summary | Description | API Calls | |
|---|---|---|---|---|
| 200 | OK | The requested resource was found and resolved. | All API calls using GET | |
| 201 | Created | The requested resource was created. The Location header contains the URL of the created resource. | All API calls using POST | |
| 204 | No Content | The requested resource was updated or deleted. | All API calls using PUT or DELETE | |
| 401 | Unauthorized | The caller could not be authenticated (typically due to invalid credentials). | All | |
| 403 | Forbidden | The referenced or default subscription may be inactive. | All | |
| 404 | Not Found | The resource, document, or document data could not be found. | All | |
| 409 | Conflict | An attempt was made to submit the same document image, data, or chip data multiple times (for example, the Front/White image may only be submitted once per transaction). | PostDocumentImage, PostDocumentChipData, PostDocumentChipAuthentication | |
| 430 | Required service operation argument not specified | One or more of the required arguments to the service operation were not specified. | GetDocumentData, GetDocumentFieldData, GetDocumentFieldImage, PostDocumentChipAuthentication, PostDocumentChipData, PostDocumentData, PostDocumentImage, PostDocumentInstance | |
| 431 | Invalid or unsupported service operation argument | One or more of the arguments supplied to the service operation are invalid or unsupported. | PostDocumentImage | |
| 432 | Document settings incomplete | The supplied document settings do not contain all of the required information necessary for processing. At a minimum, a subscription and a document capture device that includes manufacturer and model names are required. If manual classification is requested, a valid document type is also required. | PostDocumentInstance | |
| 433 | Resource identifier not in expected format | The identifier used to reference a specific resource was not supplied in the expected format. | All | |
| 434 | Subscription not found | The referenced subscription was not found or is temporarily unavailable. | PostDocumentInstance | |
| 435 | Subscription not specified | Multiple subscriptions were found for the authenticated user and one must be specified to invoke this service operation. | PostDocumentInstance | |
| 436 | Manual classification document type not found. | The referenced document type used for manual classification was not found or is temporarily unavailable. | PostDocumentInstance | |
| 437 | Document complete or in error state. | The status of the referenced document is complete or in an error state; additional images and/or data cannot be posted to the document and no further processing may be performed. | All except PostDocumentInstance | |
| 438 | Document image load failure. | The document image could not be loaded from the supplied stream due to a format, compatibility or integrity issue. | PostDocumentImage, PutDocumentImage | |
| 439 | Invalid or unsupported document image pixel depth. | The pixel depth of the document image is invalid or unsupported. The following image pixel depths are supported: | PostDocumentImage, PutDocumentImage | |
| 439 | Invalid or unsupported document image pixel depth. | Lighting | Pixel Depth | PostDocumentImage, PutDocumentImage |
| 439 | Invalid or unsupported document image pixel depth. | Visible | 24-bit RGB | PostDocumentImage, PutDocumentImage |
| 439 | Invalid or unsupported document image pixel depth. | Ultraviolet | 24-bit RGB | PostDocumentImage, PutDocumentImage |
| 439 | Invalid or unsupported document image pixel depth. | Near-Infrared | 8-bit Grayscale | PostDocumentImage, PutDocumentImage |
| 440 | Document image size is outside the acceptable range. | The width and/or height of the document image must not be less than 100 pixels. | PostDocumentImage, PutDocumentImage | |
| 441 | Document image resolution is outside the acceptable range. | The resolution of the document image must be greater than 96 DPI and less than 1,500 DPI. | PostDocumentImage, PutDocumentImage | |
| 442 | Document image resolution difference between each axis is outside the acceptable range. | The resolution difference between the horizontal and vertical axis of the document image must not exceed 5%. | PostDocumentImage, PutDocumentImage | |
| 500 | Internal Server Error. | An internal error occurred. See system log. | All | |
| 503 | Service Unavailable. | The website may be down, it may not be configured properly, or it may have insufficient credentials to run the website. | All |