Video ID Configuration

List of component configuration parameters

url

Path to the video socket

apiKey

ApiKey needed for the connection with the video socket

tenantId

Identifier of the tenant referring to the current client, necessary for the connection with the video service.

sectionTime

Indicates the duration of the sections with associated time (face capture and camera switch).

mode

• ONLY_FACE: The process is carried out by capturing the user's face.

• FACE_DOCUMENT_FRONT: The process is carried out by capturing the user's face and the front of the Identity document.

• FACE_DOCUMENT_FRONT_BACK: The process is carried out by capturing the user's face and the complete Identity document.

• DOCUMENT_FRONT: The process extracts information only from the front of the document.

• DOCUMENT_FRONT_BACK: The process extracts information only from the complete document.

timeoutServerConnection

Maximum wait time in ms for the server response.

sectionTimeout

Maximum allowed time to complete a section (in ms).

autoFaceDetection

Turns automatic face detection on/off.

debug

Enables the display of additional useful information for diagnosing and tracking internal behavior.

countryFilter

Allows restricting processing to a specific set of countries, accepting an array of strings that represent aliases in ISO3 format (3-letter code according to ISO 3166-1 standard).

documentFilter

Allows restricting the types of documents accepted during capture. The possible values are:

• "IDC": Identity document (ID Card)

• "PSP": Passport (Passport)

• "DLI": License (Driver License)

• "VIS": Visa (Visa)

• "FOC": Foreign Card (Foreign Card)

• "INV": Invoice (Invoice)

• "CUS": Custom Document (Custom Document)

speechText

Text that the user must pronounce during the video recording.

ocrValidations

Dictionary with the OCR validations to be performed. The keys are the fields to validate and the values are instances of OcrValidationValue.

OcrValidationValue has the following fields:

• value: The value to validate.

• tolerance: The tolerance level for validation.

  • STRICT: Strict validation.

  • LOW_TOLERANCE: Low tolerance validation.

  • MEDIUM_TOLERANCE: Medium tolerance validation.

  • HIGH_TOLERANCE: High tolerance validation.

• validationType: The type of validation to perform.

  • OPTIONAL: Optional validation.

  • REQUIRED: Mandatory validation.

ocrMaxWarnings

Maximum number of warnings allowed in the OCR validation.

maxRetries

Maximum number of retries allowed for the OCR validation. The default value is 3.