Tutorial

Enroll tutorial via API

Configuración

Si aún no has creado un proyecto y un projectFlow con la propiedad type = onboarding, aquí están los enlaces para hacerlo.

Crear un proyecto

ProjectFlow Setup

Create a project flow (Crear un flujo de proyecto)

optional KYC

{
    "project": "671ea085c963a3247fda57c4",
    "type": "onboarding",
    "status": "active",
    "redirectUrl": "https://debug.verifik.co",
    "onboardingSettings": {
        "steps": {
            "signUpForm": "mandatory",
            "basicInformation": "skip",
            "document": "optional",
            "liveness": "optional",
            "form": "skip"
        },
        "signUpForm": {
            "fullName": true,
            "email": true,
            "emailGateway": "mailgun",
            "phone": true,
            "phoneGateway": "both",
            "showTermsAndConditions": true,
            "showPrivacyNotice": true
        },
        "liveness": {
            "livenessMinScore": 0.7,
            "searchMode": "FAST",
            "searchMinScore": 0.85
        },
        "document": {
            "useGovernmentID": true,
            "usePassport": true,
            "useLicense": true,
            "verifyNames": true,
            "verifyCriminalHistory": true,
            "validationMethod": "SCAN_PROMPT",
            "fallbackValidationMethod": "SCAN_ZERO"
        }
    },
    "security": {
        "strategy": "blacklist",
        "source": "API",
        "apiUrl": "https://faas-nyc1-2ef2e6cc.doserverless.co/api/v1/web/fn-b88d2a3d-137b-4d8c-95af-9c4f33f69af4/passwordless-validation-url/demo-passwordless-validation-url",
        "apiTestType": "email",
        "apiTestValue": "[e-mail]"
    }
}

mandatory KYC

{
    "project": "671ea085c963a3247fda57c4",
    "type": "onboarding",
    "status": "active",
    "redirectUrl": "https://debug.verifik.co",
    "onboardingSettings": {
        "steps": {
            "signUpForm": "mandatory",
            "basicInformation": "skip",
            "document": "mandatory",
            "liveness": "mandatory",
            "form": "skip"
        },
        "signUpForm": {
            "fullName": true,
            "email": true,
            "emailGateway": "mailgun",
            "phone": true,
            "phoneGateway": "both",
            "showTermsAndConditions": true,
            "showPrivacyNotice": true
        },
        "liveness": {
            "livenessMinScore": 0.7,
            "searchMode": "FAST",
            "searchMinScore": 0.85
        },
        "document": {
            "useGovernmentID": true,
            "usePassport": true,
            "useLicense": true,
            "verifyNames": true,
            "verifyCriminalHistory": true,
            "validationMethod": "SCAN_PROMPT",
            "fallbackValidationMethod": "SCAN_ZERO"
        }
    },
    "security": {
        "strategy": "blacklist",
        "source": "API",
        "apiUrl": "https://faas-nyc1-2ef2e6cc.doserverless.co/api/v1/web/fn-b88d2a3d-137b-4d8c-95af-9c4f33f69af4/passwordless-validation-url/demo-passwordless-validation-url",
        "apiTestType": "email",
        "apiTestValue": "[e-mail]"
    }
}

Comencemos

El flujo comienza principalmente con la creación de AppRegistration, luego procedemos con la creación de la validación de correo electrónico o validación de teléfono (dependiendo de la configuración dentro del ProjectFlow), lo que nos permitirá redirigir al usuario y completar el registro sin el proceso KYC, o continuar con las siguientes validaciones.

Estas validaciones comienzan con la validación de documentos, seguida de la detección de vida, para posteriormente realizar una comparación entre la foto del documento y la selfie tomada.

Crear un registro en la app

Configuration

Based on the configuration we will stat with the signUpForm validations. The email and phone validations are the first ones to do.

"signUpForm": {
    "fullName": true,
    "email": true,
    "emailGateway": "mailgun",
    "phone": true,
    "phoneGateway": "both", // sms or whatsapp
    "showTermsAndConditions": true,
    "showPrivacyNotice": true
},

Validación de Correo Electrónico

Cada validación comienza iniciándola con los parámetros requeridos para activarse. En el caso del correo electrónico, se necesita la dirección de correo para que el usuario pueda recibir la contraseña de un solo uso (OTP).

Crear validación de correo electrónico

Una vez que se envía el correo electrónico, el usuario recibirá una contraseña de un solo uso (OTP) de 6 dígitos. Debe ingresar este OTP en la interfaz de usuario (UI) o enviarlo al siguiente endpoint de la API.

Validar la validación de correo electrónico

---

Validación de Teléfono

Si la AppRegistration necesita validar el teléfono también, tendremos que repetir el mismo proceso con algunos cambios. Para la validación de teléfono, es necesario proporcionar el phoneGateway (sms, whatsapp), el countryCode y el phone.

Crear Validación de Teléfono

Después de que se envíe el mensaje por SMS o WhatsApp, el usuario recibirá una contraseña de un solo uso (OTP) de 6 dígitos. Debe ingresar este OTP en la interfaz de usuario (UI) o enviarlo al siguiente endpoint de la API.

Validar la Validación de Teléfono

Validación de Documento

Si la AppRegistration necesita validar un documento legal, será necesario crear una documentValidation, la cual requerirá una foto del documento para extraer la información mediante nuestro sistema OCR. Determinaremos si el documento requiere una cara posterior o si está completo solo con la cara frontal.

Crear documento de validación

Validación Biométrica

Si la AppRegistration necesita validar la prueba de vida de la persona, será necesario crear una biometricValidation, la cual requerirá una selfie de la persona que está realizando el registro. Se llevarán a cabo varias verificaciones, como una búsqueda 1:N para detectar duplicados y se asignará un puntaje de detección de vida, el cual se comparará con el puntaje mínimo de detección de vida configurado en el ProjectFlow.

Primero, iniciaremos el proceso para poder realizar la validación a continuación.

Crear Validación Biométrica

Después de que tengamos una sesión, usaremos esa sesión para realizar la extracción de la selfie y aceptaremos una imagen en base64, la cual se pasará a nuestro modelo de detección de vida y devolverá un puntaje.

Validar la Validación Biométrica