Onboarding settings (Configuración de incorporación)

Visión General

Onboarding Settings se refiere a todas las configuraciones y pasos que se llevarán a cabo durante el proceso de incorporación (onboarding) para Smart Access. Esta configuración permite personalizar cómo se presentarán los diferentes pasos del flujo de onboarding al usuario, definiendo si son obligatorios, opcionales, o pueden omitirse

A continuación, se explican cada uno de estos elementos y su función en la configuración:

"onboardingSettings": {
  "steps": {
    "signUpForm": "mandatory",
    "basicInformation": "mandatory",
    "document": "mandatory",
    "liveness": "mandatory",
    "form": "mandatory"
  },
  "signUpForm": {
    "fullName": true,
    "firstName": true,
    "lastName": true,
    "email": true,
    "emailGateway": "none",
    "phone": true,
    "phoneGateway": "none",
    "extraFields": [],
    "showTermsAndConditions": true,
    "showPrivacyNotice": true
  },
  "basicInformation": {
    "age": true,
    "dateOfBirth": true,
    "gender": true,
    "address": true,
    "postalCode": true
  },
  "document": {
    "useGovernmentID": true,
    "usePassport": true,
    "useLicense": true,
    "verifyNames": true,
    "verifyCriminalHistory": true,
    "criminalEndpoints": [],
    "uploadDocumentAllowed": true,
    "scanDocumentAllowed": true,
    "validationMethod": "SCAN_PROMPT",
    "fallbackValidationMethod": "SCAN_PROMPT",
    "compareMinScore": 0.67,
    "maxAttempts": 3
  },
  "liveness": {
    "livenessMinScore": 0.9,
    "searchMode": "FAST",
    "searchMinScore": 0.95,
    "maxAttempts": 3
  },
}

---

Explicación de Conceptos Claves:

• Mandatory: El paso o campo es obligatorio, y el usuario no puede continuar sin completarlo.

• Optional: El paso o campo no es obligatorio, y el usuario puede elegir omitirlo.

• Skip: El paso o campo es completamente omitido en el flujo.

Pasos

steps: Define los diferentes pasos en el proceso de onboarding y establece si son obligatorios (mandatory), opcionales (optional) o pueden ser omitidos (skip).

options: ["mandatory", "optional", "skip"]

• signUpForm: Define si el formulario de registro es obligatorio, opcional o puede ser omitido.

• basicInformation: Define si la recopilación de información básica del usuario (por ejemplo, nombre, correo electrónico) es obligatoria, opcional o puede ser omitida.

• document: Especifica el requisito de presentar documentos como identificaciones oficiales o licencias.

• liveness: Especifica el uso de detección de prueba de vida (reconocimiento facial) durante el proceso de onboarding.

• form: Se refiere al formulario personalizado que puede presentarse como parte del flujo de onboarding.

SignUp Form

signUpForm: Esta sección define los campos que formarán parte del formulario de registro.

• fullName: Un booleano que determina si el campo de nombre completo forma parte del formulario de registro.

• firstName: Un booleano que determina si el campo de nombre es obligatorio.

• lastName: Un booleano que determina si el campo de apellido es obligatorio.

• email: Un booleano que determina si el campo de correo electrónico es obligatorio para el registro.

• emailGateway: Especifica el proveedor de verificación de correo electrónico, como "mailgun" o "none".

• phone: Un booleano que determina si el campo de número de teléfono es obligatorio.

• phoneGateway: Especifica el proveedor de verificación de teléfono, como "sms", "whatsapp", "both" o "none".

• extraFields: Una lista que puede contener campos adicionales requeridos durante el proceso de registro.

• showTermsAndConditions: Un booleano que especifica si se deben mostrar los Términos y Condiciones.

• showPrivacyNotice: Un booleano que especifica si se debe mostrar un Aviso de Privacidad.

Basic Information

basicInformation: Define los campos requeridos para recopilar la información básica del usuario.

• age: Un booleano que determina si el campo de edad es obligatorio.

• dateOfBirth: Un booleano que determina si el campo de fecha de nacimiento es obligatorio.

• gender: Un booleano que determina si el campo de género es obligatorio.

• address: Un booleano que determina si el campo de dirección es obligatorio.

• postalCode: Un booleano que determina si el campo de código postal es obligatorio.

Documento

Documento: Define la configuración para el proceso de validación de documentos.

• useGovernmentID: Un booleano que determina si se requiere una identificación oficial emitida por el gobierno.

• usePassport: Un booleano que determina si se puede usar un pasaporte como identificación.

• useLicense: Un booleano que determina si se puede usar una licencia de conducir como identificación.

• verifyNames: Un booleano que determina si el nombre del usuario será verificado con el documento.

• verifyCriminalHistory: Un booleano que determina si se verificará el historial criminal del usuario.

• criminalEndpoints: Una lista de endpoints para consultar antecedentes penales.

• uploadDocumentAllowed: Un booleano que determina si se permite subir documentos.

• scanDocumentAllowed: Un booleano que determina si se permite escanear documentos.

• validationMethod: Especifica el método utilizado para la validación del documento. Opciones: "SCAN_ZERO", "SCAN_PROMPT", "SCAN_STUDIO".

• fallbackValidationMethod: Especifica el método de respaldo para la validación en caso de que falle el método principal.

• compareMinScore: Un número entre 0.5 y 1 que determina la puntuación mínima requerida para que la validación del documento sea exitosa.

• maxAttempts: Especifica el número máximo de intentos permitidos para la validación del documento.

Liveness

Liveness: Define la configuración para la detección de prueba de vida (para confirmar que el usuario está físicamente presente durante el proceso de onboarding).

• livenessMinScore: Un número que especifica la puntuación mínima requerida para la detección de prueba de vida.

• searchMode: Define el modo de reconocimiento facial. Opciones: "FAST" o "ACCURATE".

• searchMinScore: Especifica la puntuación mínima requerida para considerar una coincidencia entre el rostro del usuario y los datos almacenados.

• maxAttempts: Especifica el número máximo de intentos permitidos para la detección de prueba de vida.