Final states
IDentity form status and state codes, their meaning, and recommended actions. Includes Submitted and Pending Review processing states.
Search states and recommended actions →
This reference applies to IDentity. Preserve state codes as strings, including leading zeros and N/A. Submitted and Pending Review are processing states, not final decisions. For temporary review states, use the Review states reference.
APPENDIX C – Form Status and State Codes
The following table contains a list of values that will be returned in the tag ‘State’ in the response. This indicates the overall result of the ID Validation and/or any additional processing based on the Service ID. The table also includes a recommendation for action for the requesting application.
Note: If Manual Review is supported for your configuration, these initially would go into a result state with the word ‘Review…’ in front of the result. Once the form is actioned by the manual review team, it would be updated to reflect the states below. These Form Status and State Code values for Manual Review are in APPENDIX D.
Form State Returns and State Codes Table
State Code |
Form Status |
Description | Recommended Actions |
|---|---|---|---|
| 00 | Approved |
|
|
| 50 | Barcode Unreadable | A barcode is expected to be present, but the barcode data is not detected by IDmission. | The application using this API should prompt the user to recapture the images where the barcode is present in better lighting without glare so the ID can be processed properly. |
| 32 | Biometric Match Fail | If the user’s biometric data (face, voice, and/or fingerprint) captured does not match the biometric data in the database from a previously enrolled user. | The application using this SDK/API should prompt the user to recapture their biometric information, ensuring that face, fingerprint, and voice can be captured with clarity and accuracy. |
| 46 | Customer Found | If the customer biometric data (face, voice, and/or fingerprint) has matched the biometric data in the database of a previous enrollment. |
|
| 44 | Customer Not Found | If the customer biometric data (face, voice, and/or fingerprint) does not match the biometric data in the database from a previously enrolled user. | The application using this SDK/API should prompt the user to recapture their biometric information. The capture should be completed in a well-lit room with the customer biometric fully visible. |
| 34 | Customer Onboarded |
|
|
| 37 | Customer Onboarding Failed |
|
|
| 39 | Customer Updated | If the capture of customer data has updated a previously enrolled customer record. |
|
| 135 | DOB Match Failed | If the Date of Birth submitted in the request for the Customer or the Employee doesn’t meet the matching thresholds against the Date of Birth extracted from the ID Document. | The application using this API should prompt the user to provide a valid ID as this was deemed invalid. |
| 35 | Duplicate Customer | The biometric data provided by the customer for a new enrollment has matched to a previously enrolled user. |
|
| 36 | Duplicate Employee | The biometric data provided by the employee for a new enrollment has matched to biometric data from a previous enrollment. |
|
| 47 | Employee Found | If the customer biometric data (face, voice, and/or fingerprint) has matched the biometric data in the database of a previous enrollment. |
|
| 45 | Employee Not Found | If the customer biometric data (face, voice, and/or fingerprint) does not match the biometric data in the database from a previously enrolled user. | The application using this SDK/API should prompt the user to recapture their biometric information. The capture should be completed in a well-lit room with the customer biometric fully visible. |
| 33 | Employee Onboarded |
|
|
| 38 | Employee Onboarding Failed |
|
|
| 41 | Employee Updated | If the capture of employee data has updated a previously enrolled customer record. |
|
| 40 | Expired ID | The expiration date on the ID is equal to or less than the current date. | The application using this API should prompt the user to provide an ID with a valid expiration date. |
| 137 | Expiry Date Match Failed | If the Expiration Date submitted in the request for the Customer or the Employee doesn’t meet the matching thresholds against the Expiration Date extracted from the ID Document. | The application using this API should prompt the user to provide a valid ID as this was deemed invalid. |
| 31 | Face Not Detected |
|
The application using this API should prompt the user to provide a clear image of an ID that includes a photo. |
| 30 | Facial Biometric Match Failed | If a customer photo is captured and does not biometrically match the photo in the ID document, the ability to review the images is in the back office. | The application using this API should prompt the user to capture a new selfie image. |
| 10 | ID Back Image not found |
|
The application using this API should prompt the user to provide a clear image of the back of the ID. |
| 52 | ID Face Not Found |
|
The application using this SDK/API should prompt the user to provide a clear ID with a clear face image to ensure that facial biometric verification can be completed. |
| 60 | ID Front and Back Mismatch | If the data extracted from the back of the ID image does not belong to the data presented on the front of the ID image. | The application using the API should prompt the user to provide new front and back images because inconsistences were found. Note: If this occurs more than once, the application could decide to push this to a manual review queue because it could be an issue with OCR extraction accuracy. |
| 11 | ID Front Image Not Found | The front of an ID is not uploaded, or a blank image was provided. | The application using this API should prompt the user to provide a clear image of the front of the ID. |
| 61 | ID Not Accepted | The uploaded ID contains an invalid configuration for the selected country. | The application using this API should prompt the user to provide an ID that is in the list of accepted ID Types. Note: The application should prompt the user to select an ID type from a dropdown list, which reduces the likeliness of this result. |
| 62 | ID Type Mismatch | If the ID Type submitted doesn’t match the ID Type extracted from the ID Image. | The application using this API should prompt the user to select the ID Type that matches the Type of ID that was uploaded/captured. |
| 51 | IDNumber Match Failed | The ID Number that was extracted by OCR from the ID does not match the ID Number that was extracted from the MRZ or Barcode, OR the ID Number submitted in the request does not match the ID Number that was extracted through OCR. | The application using this SDK/API should prompt the user to retry ID Validation. |
| 63 | Invalid ID Number | The ID Number on the ID does not match the pattern defined in the ID Template. | The application using this API should prompt the user to provide a valid ID. |
| 12 | Key Component Not Visible | If one of the key components on the ID such as the date of birth or expiration date is missing. | The application using this SDK should prompt the user that: The ID they have provided is not valid or the image provided may be blurred or unreadable in some portions or to recapture or capture an image of a different ID. |
| 13 | Low Resolution |
|
The application using this API should prompt the user to recapture the images in better lighting without glare so the ID can be processed properly. |
| 48 | Live Face Detected | If our system detects a live face from the selfie. |
|
| 49 | Live Face Not Detected | If our system does not detect a live face from the selfie image (e.g., if the selfie image is a photo of a photo, if the selfie image is a screen capture of a face, etc.) | The application using the SDK should prompt the user to retake the selfie ensuring that a live face is captured in good lighting. |
| 64 | MRZ and ID Data Mismatch | If the data extracted from the MRZ does not match the data extracted from the ID image itself. | The application using the API should prompt the user to provide new image(s) because inconsistences were found. Note: If this occurs more than once, the application could decide to push this to a manual review queue because it could be an issue with OCR extraction accuracy. |
| 65 | MRZ Invalid | The MRZ Validation flag (Machine Readable Zone) results in determining that the MRZ Data was not correct according to the standards. | The application using this API should prompt the user that the ID they have provided is not valid and to capture image of a different ID. |
| 66 | Name Match Failed | If the name submitted for the Customer or the Employee doesn’t meet the matching thresholds against the name extracted from the ID Document. | The application using this API should prompt the user to provide a valid ID as this was deemed invalid. |
| 14 | No Image Found | The ID front and back images are black or white and missing an ID Image. | The application using this API should prompt the user to recapture the images in better lighting without glare so the ID can be processed properly. |
| N/A | Pending Review | Initial state of the form. System checks are still pending. | No action required. Final results are sent via the POST API |
| 53 | Real ID Detected | If our system detects a real ID from the ID image. |
|
| 54 | Real ID Not Detected | If our system does not detect a real ID from the ID image (e.g., if the ID image is a photocopy, if the ID image is a screen capture of an ID, etc.) | The application using the SDK should prompt the user to retake the ID image ensuring that a real ID is captured in good lighting. |
| 67 | Sample ID | If an ID has been confirmed as a sample after manual review. | The application using this API should prompt the user that: The ID they have provided is not valid and to capture a different ID image. |
| 68 | Security Feature Invalid | One or more security features defined for the ID template are a mismatch with the provided image. | The application using this API should prompt the user to recapture the ID or a different one. |
| 01 | Submitted | If it is an asynchronous call via the API, the ID is awaiting process completion to be categorized into a form state. |
|
| 69 | Suspected Sample | An ID has been detected as a sample (logic has been configured to recognize sample ID numbers, names, watermarks and other suspected sample data.) | The application using this API should prompt the user that the ID they have provided is not valid and to capture image of a different ID. |
| 70 | Suspected Tampering |
|
The application using this API should prompt the user that the ID they have provided is not valid and to capture image of a different ID. |
| 73 | Suspicious ID |
|
The application using this API should prompt the user that the ID they have provided is not valid and to capture an image of a different ID. |
| 71 | Tampered ID | An ID has been confirmed to be tampered with after manual review. | The application using this API should prompt the user that the ID they have provided is not valid and to capture image of a different ID. |
| 15 | Template Not Found | The correct template cannot be matched against those configured for the client. Note: The system will not find a template to associate with the image for correct data extraction and validation. |
The application using the API should prompt the user to capture a different ID. |
| 80 | Third Party Verification Failed | If an ID has not been successfully verified by a third party. |
|
| 72 | Under the age of 18 | The date of birth (extracted from the barcode / MRZ) calculates the individual as under the age of 18. |
The date of birth indicates that the user is under the age of 18 Note: The API can determine if this was already indicated in the application. If it was not indicated, the API should prompt for correct ID. |
| 118 | Under the Age of 21 | The date of birth (extracted from the barcode / MRZ) calculates the individual as under the age of 21. | The date of birth indicates that the user is under the age of 21. Note: The API can determine if this was already indicated in the application. If it was not indicated, the API should prompt for correct ID. |
| 129 | VideoID Audio Match Failed | The user’s Audio captured in the videoID does not match the Audio data in the database from a previously enrolled user. | The application using this SDK/API should prompt the user to recapture their VideoID and can be captured with clarity and accuracy. |
| 131 | ID and VideoID Not Matched | The user's captured ID does not match the ID in the VideoID | The application using this SDK/API should prompt the user to recapture their VideoID and can be captured with clarity and accuracy. |
| 133 | VideoID Face Match Failed | The user's captured Selfie does not match the Face in the VideoID | The application using this SDK/API should prompt the user to recapture their VideoID and can be captured with clarity and accuracy. |
Report a docs issue
Copy this context into your team’s issue tracker or an email to support@idmission.com.
