Video ID Result

List of component output parameters

finishStatus

Returns a number from the operation result. Possible values:

• 1: The operation was successful.

• 2: An error has occurred, which will be indicated in the string errorType and, optionally, an extra information message will be shown in the property errorMessage.

finishStatusDescription

Returns a description of the operation result. Possible values:

• STATUS_OK: The operation was successful.

• STATUS_ERROR: An error has occurred, which will be indicated in the string errorType(errorDiagnostic for Flutter) and, optionally, an extra information message will be shown in the property errorMessage.

errorType or errorDiagnostic(only for Flutter)

Indicates why the component failed.

errorMessage

Indicates an additional error message. It is an optional value.

frontDocumentData

Data from the front of the document. Includes:

• documentImage: Document image

• documentFullImage: Captured full image

• documentFaceImage: If a face is found in the document, its image is returned.

• iqaOverExposure: Numeric value between 0 and 1 that indicates the image overexposure level; a high value suggests that the image is too bright, which may make it difficult to read the document.

• iqaReadable: Numeric value between 0 and 1 that indicates the readability of the document text; higher values imply that the text is clearer and easier to recognize.

• iqaSharpness: Numeric value between 0 and 1 that indicates the sharpness of the document image; high values reflect a more focused image, which improves the ability to extract data.

• documentFaceImageTokenized: If a face is found in the document, its encrypted image is returned.

backDocumentData

Data from the back of the document. Includes:

• documentImage: Document image

• documentFullImage: Captured full image

• documentFaceImage: If a face is found in the document, its image is returned.

• iqaOverExposure: Numeric value between 0 and 1 that indicates the image overexposure level; a high value suggests that the image is too bright, which may make it difficult to read the document.

• iqaReadable: Numeric value between 0 and 1 that indicates the readability of the document text; higher values imply that the text is clearer and easier to recognize.

• iqaSharpness: Numeric value between 0 and 1 that indicates the sharpness of the document image; high values reflect a more focused image, which improves the ability to extract data.

• documentFaceImageTokenized: If a face is found in the document, its encrypted image is returned.

faceImage

User image captured in the first section of the process.

ocrMap

Map of the OCR extracted from the document.

ocrDiagnostic

Dictionary with the OCR diagnosis of the document. The keys are the fields to validate and the values are instances of OcrDiagnostic.

OCR diagnosis extracted from the document.

• OK: The OCR is correct.

• NOT_FOUND: The OCR key is not found.

• TOLERANCE_ERROR: The OCR is not correct.

• WARNING: The OCR is not correct, but it is only a warning because it is an optional field.

matchingSidesScore

Numeric value between 0 and 1 that estimates the level of match between the faces of the document (front and back).

documentType

Obtained document type.

personalData

Reduced set of data obtained from the user:

• issuer

• documentNumber

• issueDate

• expiryDate

• name

• surname

• fullName

• gender

• birthDate

• birthPlace

• nationality

• address

• nfcKey

• numSupport

• mrz

speechText

Text that the user must pronounce during the video recording.

faceImageTokenized

Encrypted user image captured in the first section of the process.