El objeto de Validación de Documentos
Atributos
documentNumber - String - Opcional Número asociado con el documento que se está validando.
documentType - String - Requerido Tipo de documento, como ID, Pasaporte o Licencia de Conducir.
documentCategory - String - Opcional Categoría del documento con valores posibles:
ID
Passport
IDv2
ForeignerID
DriverLicense
Unknown Predeterminado: Unknown.
customDocumentType - String - Opcional Tipo de documento personalizado si se requiere una clasificación específica.
country - String - Opcional País donde se emitió el documento.
nationality - String - Opcional Nacionalidad del titular del documento.
age - String - Opcional Edad del titular del documento según se registra en el mismo.
gender - String - Opcional Género del titular del documento.
project - ObjectId - Opcional Referencia al objeto Proyecto asociado con esta validación de documento.
projectFlow - ObjectId - Opcional Referencia al objeto ProjectFlow asociado con esta validación de documento.
url - String - Opcional URL donde se puede acceder al documento.
backUrl - String - Opcional URL del reverso del documento, si corresponde.
status - String - Requerido Estado actual de la validación del documento. Valores posibles:
ASSESSING
ACTIVE
FAILED
NEEDS_MANUAL_VERIFICATION
NOT_FOUND
EXPIRED
ACTIVE_BUT_UNVERIFIED Predeterminado: ASSESSING.
imageValidated - Boolean - Opcional Indica si la imagen del documento ha sido validada. Predeterminado: false.
validationMethod - String - Requerido Método utilizado para la validación. Valores posibles:
MANUAL
OCR
SCAN_PROMPT
SCAN_STUDIO Predeterminado: MANUAL.
inputMethod - String - Requerido Método utilizado para ingresar el documento. Valores posibles:
CAMERA
FILE_UPLOAD
NOT_SET Predeterminado: NOT_SET.
namesMatch - Boolean - Opcional Indica si los nombres en el documento coinciden con los nombres esperados. Predeterminado: false.
fullNameMatchPercentage - Number - Opcional Porcentaje de coincidencia del nombre completo. Predeterminado: 0.
firstNameMatchPercentage - Number - Opcional Porcentaje de coincidencia del primer nombre. Predeterminado: 0.
lastNameMatchPercentage - Number - Opcional Porcentaje de coincidencia del apellido. Predeterminado: 0.
OCRExtraction - Object - Opcional Objeto que contiene los datos extraídos por OCR si se utilizó esta tecnología.
scoreValidated - Boolean - Opcional Indica si hay una puntuación de validación disponible. Predeterminado: false.
scoreValidation - Object - Opcional Objeto para almacenar puntuaciones y detalles de validación.
type - String - Requerido Tipo de proceso de validación. Valores posibles:
validation
login
signup
ocr
demo Predeterminado: validation.
redirectUrl - String - Opcional URL de redirección después de la validación.
webhookUrl - String - Opcional URL para la devolución de llamada del webhook después de la validación.
webhook - ObjectId - Opcional Referencia al objeto Webhook asociado.
appRegistration - ObjectId - Opcional Referencia al objeto AppRegistration asociado.
client - ObjectId - Opcional Referencia al objeto Cliente asociado.
Representación JSON de Ejemplo
{
"documentNumber": "123456789",
"documentType": "Passport",
"documentCategory": "ID",
"customDocumentType": "NationalID",
"country": "USA",
"nationality": "American",
"age": "30",
"gender": "M",
"project": "ObjectId('...')",
"projectFlow": "ObjectId('...')",
"url": "https://example.com/document-front",
"backUrl": "https://example.com/document-back",
"status": "ASSESSING",
"imageValidated": false,
"validationMethod": "OCR",
"inputMethod": "CAMERA",
"namesMatch": true,
"fullNameMatchPercentage": 98,
"firstNameMatchPercentage": 100,
"lastNameMatchPercentage": 97,
"OCRExtraction": {
"documentNumber": "123456789",
"fullName": "John Doe"
},
"scoreValidated": true,
"scoreValidation": {
"score": 90,
"threshold": 85
},
"type": "validation",
"redirectUrl": "https://example.com/redirect",
"webhookUrl": "https://example.com/webhook",
"webhook": "ObjectId('...')",
"appRegistration": "ObjectId('...')",
"client": "ObjectId('...')"
}Last updated