Complete Status

Overview
The overallStatus field in the API response is a critical indicator that provides a summary of the entire verification process conducted on an identification document. This status combines the results of various checks performed, including optical, RFID, and other security features, to give a comprehensive view of the document's authenticity and the quality of the data extracted.
Explanation of Values
True: Indicates that the verification check was performed and the document or feature passed the check.
False: Indicates that the verification check was performed but the document or feature failed the check.
None: Indicates that the verification check was not performed or is not applicable.
API Response Details: completeStatus
Here's an updated detailed table-format explanation for each parameter within the completeStatus object in the API response, including the detailsRFID object:
Parameter
Sub-Parameter
Data Type
Possible Values
Description
completeStatus
﻿
Object
﻿
Container for all detailed verification results.
optical
﻿
String
True, False, None
Summary of all optical checks.
overallStatus
﻿
String
True, False, None
Summary result of all verification checks.
portrait
﻿
String
True, False, None
Verification result for the portrait comparison.
rfid
﻿
String
True, False, None
Summary of all RFID checks.
detailsOptical
﻿
Object
﻿
Detailed results from optical checks.
﻿
docType
String
True, False, None
Indicates if the document type was correctly recognized.
﻿
expiry
String
True, False, None
Verification of the document's validity period.
﻿
imageQA
String
True, False, None
Quality assessment of the input images.
﻿
mrz
String
True, False, None
Verification status of the Machine Readable Zone (MRZ).
﻿
overallStatus
String
True, False, None
Aggregated result of all optical checks.
﻿
pagesCount
Integer
﻿
Number of pages counted in the scanned document.
﻿
security
String
True, False, None
Status of authenticity checks based on security features.
﻿
text
String
True, False, None
Verification of text fields for consistency and accuracy.
﻿
vds
String
True, False, None
Verification of the Visible Digital Seal (VDS).
detailsRFID
﻿
Object
﻿
Detailed results from RFID checks.
﻿
overallStatus
String
True, False, None
Summary result of all RFID checks.
﻿
BAC
String
True, False, None
Status of Basic Access Control verification.
﻿
PACE
String
True, False, None
Status of Password Authenticated Connection Establishment.
﻿
CA
String
True, False, None
Status of Chip Authentication.
﻿
TA
String
True, False, None
Status of Terminal Authentication.
﻿
AA
String
True, False, None
Status of Active Authentication.
﻿
PA
String
True, False, None
Status of Passive Authentication.
Explanation and Usage
Overall Checks (overallStatus, optical , rfid ): These fields summarize the results from various categories of checks, helping users quickly identify potential issues.
Optical Details (detailsOptical): This object provides a breakdown of each optical-based verification process, which is critical for analyzing the physical aspects of the ID document.
RFID Details (detailsRfid): This object delves into the electronic verification aspects of the ID, crucial for modern IDs with embedded chips, enhancing the depth and reliability of security checks.
﻿

Parameter	Sub-Parameter	Data Type	Possible Values	Description
completeStatus		Object		Container for all detailed verification results.
optical		String	True, False, None	Summary of all optical checks.
overallStatus		String	True, False, None	Summary result of all verification checks.
portrait		String	True, False, None	Verification result for the portrait comparison.
rfid		String	True, False, None	Summary of all RFID checks.
detailsOptical		Object		Detailed results from optical checks.
	docType	String	True, False, None	Indicates if the document type was correctly recognized.
	expiry	String	True, False, None	Verification of the document's validity period.
	imageQA	String	True, False, None	Quality assessment of the input images.
	mrz	String	True, False, None	Verification status of the Machine Readable Zone (MRZ).
	overallStatus	String	True, False, None	Aggregated result of all optical checks.
	pagesCount	Integer		Number of pages counted in the scanned document.
	security	String	True, False, None	Status of authenticity checks based on security features.
	text	String	True, False, None	Verification of text fields for consistency and accuracy.
	vds	String	True, False, None	Verification of the Visible Digital Seal (VDS).
detailsRFID		Object		Detailed results from RFID checks.
	overallStatus	String	True, False, None	Summary result of all RFID checks.
	BAC	String	True, False, None	Status of Basic Access Control verification.
	PACE	String	True, False, None	Status of Password Authenticated Connection Establishment.
	CA	String	True, False, None	Status of Chip Authentication.
	TA	String	True, False, None	Status of Terminal Authentication.
	AA	String	True, False, None	Status of Active Authentication.
	PA	String	True, False, None	Status of Passive Authentication.

Did this page help you?

ID Intelligence Advance

Image Quality