ID Verification processResult Definitions
Applies to: Direct | Capture
This page describes the status code responses from the idcheck
signal returned in the /get-results
endpoint.
The following table describes processResult
status codes.
Status Code | Description |
---|---|
DocumentProcessOK | We authenticated the document. This status code means the document was successfully decoded. |
DocumentUnknown | We did not authenticate the document. This status code can be interpreted in two ways.
|
DocumentBadRead | We encountered an error reading media off the document. This status code is returned for certain barcode readers that detect bad reads and provide a read-error result to indicate that a card was detected but no barcode was found. |
DocumentBadDevice | We were unable to process the submitted data. This status code is returned for an unsupported reading device (see Device Type Parameter), or if the barcode was not extracted from the image data. |
DocumentFinancial | We detected a financial card. This status code means the document was a financial card, for example, a credit card or a benefits card. Financial cards are not processed. |
Document1DDocument | We detected 1D barcode data. This status code means a 1D barcode was detected. 1D barcodes are not processed. We can only process a 2D barcode. |
ErrorBadConfiguration | Jurisdiction processing failed. This status code means that an error occurred during startup or initialization. Contact Intellicheck customer support. |
UnexpectedError | We detected an unknown error while processing the document. This status code means that our system encountered an unexpected result. Contact Intellicheck customer support. |
Contact Intellicheck customer support for ErrorBadConfiguration and UnexpectedError status codes.
Extended Result Codes
An extended result code provides diagnostic information supplemental to the processResult
status code.
The following table describes extendedResultCode
status codes.
Status Code | Description |
---|---|
Y | Yes. The document passed verification. |
U | Unknown. The document failed verification. |
B | Bad. The request data contains errors, or the device_type parameter is invalid. See Device Type Parameter. |
IUX | Integration unexpected. The request resulted in an unexpected integration error. Contact Intellicheck support. |
F | Financial. The document data submitted is from a financial document. |
1 | One-D. The document data submitted is from a 1D barcode. |
UEE | Unexpected event error. The request resulted in an unexpected error. Contact Intellicheck support. |
Contact Intellicheck support for IUX and UEE status codes.
Updated 4 months ago