Vocabulary

Common values vocabulary

Value	Meaning
clientId	A unique string identifying a client.
scanRef	A unique string identifying a client verification in iDenfy’s side.

Verification status values vocabulary

Value	Explanation
APPROVED	Verification was successful and approved by an automated platform or a manual reviewer. An overall status of the verification. It is a combination of manual and automatic verification results. Please refer to autoFace, manualFace, autoDocument and manualDocument statuses.
DENIED	Verification was not successful and was denied by an automated platform or a manual reviewer. An overall status of the verification. It is a combination of manual and automatic verification results. Please refer to autoFace, manualFace, autoDocument and manualDocument statuses.
SUSPECTED	Overall status of the verification. It depends on auto or manual webhook, but if face status:autoFace, manualFace is FACE_MATCH and document status autoDocument, manualDocument is DOC_VALIDATED, then the verification is approved. If other statuses exist, for example: DOC_NOT_FOUND, FACE_MISMATCH, then verification is declined. If any fraudTags or mismatchTags exist for the verification, then status can be set as SUSPECTED, because the identification caught some discrepancies. If verification is approved(FACE_MATCH and DOC_VALIDATED) but overall status SUSPECTED it should be decided on your end to allow or decline this client.
REVIEWING	Verification is being reviewed by a human. Contact iDenfy support to turn this feature on or off.
EXPIRED	A token associated with this verification got expired and a verification process never took place (token was not used).
ACTIVE	A verifications has no decisive status. A token representing this verification was not used and is still active and can be used by a client any moment.
EXPIRED-DELETED	A token associated with this identification got expired and a verifications process never took place (token was not used and got deleted).
DELETED	For performance reasons we might decide to delete certain verifications.
ARCHIVED	For performance reasons we might decide to archive certain verifications.
FACE_MATCH	Face from document was successfully matched with the selfie face. This status indicates that the person and the owner of the document are the same.
FACE_MISMATCH	The face of a verifying person could not be determined as facial features are not fully visible or there a few similar faces in the photo. It could be of low-quality pictures and/or changes in a person's facial features during a lifetime and/or blur, shadow, glare, fingers or other objects in the photo.
NO_FACE_FOUND	The face cannot be accurately determined or facial features are not clear in the photo. The selfie might be effected by blur, shadow, glare, fingers or other objects in the photo.
TOO_MANY_FACES	In the given selfie photo more than one face is visible. We can not accurately determine which face to match and/or the law prohibits more than one face in the verification selfie.
FACE_TOO_BLURRY	Selfie face was too blurry and face matching could not be performed.
FACE_ERROR	Unclassified error happened when locating/matching faces.
FACE_NOT_ANALYSED	Verification was denied for some other reason e.g. it was suspected therefore face analysis was not performed.
FACE_NOT_CHECKED	This status indicates that the selfie was not compared to the documents face.
FAKE_FACE	The photo were taken not in a real time, virtual camera were detected or face is fake. It also could occured of blur, shadow, glare, fingers, or other objects in the photo.
FACE_GLARED	Detected glare in selfie photo.
FACE_UNCERTAIN	Selfie face liveness can not be determined. This means that it might be because of not well-lit environment, fake face provided or blur, shadow, glare, fingers or other objects in the photo.
DOC_VALIDATED	Document is valid. This means that all data is visible and read, document face is foundand document seems to be genuine.
DOC_NOT_FOUND	Document could not be found in the photo.
DOC_NOT_FULLY_VISIBLE	This status indicates that the document or some information in the document are not fully visible. It occurred of not showing the document, blur, shadow, glare, fingers, damaged document, or other objects in the photo.
DOC_NOT_SUPPORTED	The client has shown a document type that is not supported for a selected country, not allowed for currect session, or type of document does not match with selected.
DOC_FACE_NOT_FOUND	A face in the document could not be located.
DOC_NAME_ERROR	In the front side of the document a name field could not be found or parsed.
DOC_SURNAME_ERROR	In the front side of the document a surname field could not be found or parsed.
DOC_EXPIRY_ERROR	In the front side of the document a document expiry date field could not be found or parsed.
DOC_DOB_ERROR	In the front side of the document a date of birth field could not be found or parsed.
DOC_PERSONAL_NUMBER_ERROR	In the front side of the document a personal code field could not be found or parsed.
DOC_NUMBER_ERROR	In the front side of the document a document number field could not be found or parsed.
DOC_DATE_OF_ISSUE_ERROR	In the front side of the document a date of issue field could not be found or parsed.
DOC_SEX_ERROR	In the front side of the document a sex field could not be found or parsed.
DOC_NATIONALITY_ERROR	In the front side of the document a nationality field could not be found or parsed.
DOC_GLARED	Document looks glared in the photo and data parsing can not be performed.
DOC_FACE_GLARED	Document face looks glared in the photo and data parsing can not be performed.
DOC_TOO_BLURRY	Document looks too blurry in the photo and data parsing can not be performed.
DOC_NOT_ALLOWED	Document could be read but the specific document type is not allowed in the partner's settings.
MRZ_NOT_FOUND	Machine Readable Zone (MRZ) could not be located.
MRZ_OCR_READING_ERROR	Failed to read and parse Machine Readable Zone (MRZ). Possibly check-digit discrepancy.
BARCODE_NOT_FOUND	The barcode of the document could not be located.
DOC_EXPIRED	The document shown in the photo indicates that it is expired and therefore no longer valid. It might also be effected of blur, shadow, glare, fingers, or other objects in the photo.
COUNTRY_MISMATCH	Selected country and identity document issuing country do not match.
DOC_SIDE_MISMATCH	Document side is different than expected.
DOC_TYPE_MISMATCH	Selected document type mismatches with shown document or allowed document.
DOC_ERROR	Unclassified error happened while analysing identity document.
DOC_NOT_ANALYSED	Verification was denied for some other reason e.g. it was suspected therefore document analysis was not performed.
DOC_DAMAGED	Document in the photo is damaged: it might be cracked or broken in some way.
DOC_FAKE	The photo were taken not on a real time, virtual camera were detected or document is fake. It also could occured of blur, shadow, glare, fingers, or other objects in the photo.
AUTO_UNVERIFIABLE	This verification can not be automatically verified and needs to be verified by human.
COUNTRY_NOT_SUPPORTED	Document country is not supported.
FACE_SUSPECTED	Automatic algorithms triggered a suspicion that selfie face is not genuine.
FACE_BLACKLISTED	Verification selfie has been matched against an already existing blacklist entry.
DOC_FACE_BLACKLISTED	Verification document face has been matched against an already existing blacklist entry.
DOC_MOBILE_PHOTO	A photo of a document is shown from a mobile screen.
DEV_TOOLS_OPENED	A client performing verification has opened dev-tools in the browser.
DOC_PRINT_SPOOFED	Automatic algorithms triggered a suspicion that document is printed on paper.
FAKE_PHOTO	General identifier for a fake photo.
AML_SUSPECTION	If AML functionality is turned on for you - this reason specifies that a client is in PEPs or Sanctions list.
AML_FAILED	If AML functionality is turned on for you - this reason specifies that the check has failed.
LID_SUSPECTION	If LID functionality is turned on for you - this reason specifies that client's document is found in lost or stolen documents database.
LID_FAILED	If LID functionality is turned on for you - this reason specifies that the check has failed.
UNDER_AGE	An age read from document is lower than partner age limit.
UNKNOWN_AGE	An age was not read from document and partner has set age limit.
NAME	Partner given client name does not match one read form document.
SURNAME	Partner given client surname does not match the one read form document.
DOCUMENT_NUMBER	Partner given client document number does not match the one read form document.
PERSONAL_CODE	Partner given client personal code does not match the one read form document.
EXPIRY_DATE	Partner given client expiry date does not match the one read form document.
DATE_OF_BIRTH	Partner given client date of birth does not match the one read form document.
DATE_OF_ISSUE	Partner given client date of issue does not match the one read form document.
FULL_NAME	Partner given client full name does not match the one read form document.
DOC_PERSONAL_CODE_INVALID	The personal code could not be verified. This means that the personal code is incorrect or not fully visible because of blur, shadow, glare, fingers, damaged document, or other objects in the photo.
DOC_SPOOF_DETECTED	Document detected as not real.
DOCUMENT_TOO_CLOSE_TO_BORDER	Passive document liveness failed to successfully validate the document image because it is too close & borders are outside.
MRZ_INVALID	Machine readable zone (MRZ) is invalid and cannot be verified. It occured ofblur, shadow, glare, fingers, damaged document, other objects in the photo or it may be eddited by the client.
INVALID_ADDITIONAL_STEP	Additional step document was invalid'.
ADDITIONAL_STEP_NOT_FOUND	Additional step was not found.
FACE_IN_BLACKLIST	This particular verification face photo was added to face blacklist.
DOC_FACE_IN_BLACKLIST	This particular verification document face photo was added to document blacklist.
DATA_BLACKLISTED	Verification data has been matched against an already existing blacklist entry.
DATA_IN_BLACKLIST	This verification data has been used to create blacklist entry, e.g. when scanRef is added to blacklist.
DUPLICATE_FACE	A face matched with earlier done verification selfie.
DUPLICATE_DOC_FACE	A document face matched with earlier done verification document face.
VIRTUAL_CAMERA	Likely virtual camera detected.
DOC_INFO_MISMATCH	The information provided does not match between the system and the document.
UNDER_AGE	The client is under certain age limit.
ADDITIONAL_STEP_INFORMATION_MISMATCH	The additional step information does not match with the document provided.
EXPIRED_ADDITIONAL_STEP_INFORMATION	The provided document is expired
INVALID_ADDITIONAL_STEP	Additional step is invalid
ADDRESS_UNVERIFIED	Address verification hasn't been performed because: - address was not matched, - address was matched but not found, - UTILTIY_BILL additional step document expired (EXPIRED_ADDITIONAL_STEP_INFORMATION). Also possible it was performed, matched and found but status is unverified.
PORTRAIT_SUBSTITUTION	Passive document liveness failed to successfully validate the document photo and marked as it might be replaced/substituted.