Verifik
Verifik
Verifik
  • Documentation
  • Accounts
    • Authentication
      • Email Authentication
      • Phone Authentication
      • Renew your token (JWT)
      • Create new token & revoke previous tokens
    • Clients
      • Account information
  • Services
    • SmartCheck
      • App Query example
    • SmartAccess
      • Dashboard
    • Access
      • Email Access Example
      • Phone Access Example
      • Biometric Access Example
    • SmartEnroll
    • Enroll
      • Tutorial
    • Smart Scan
  • Biometrics API's
    • Liveness
      • Liveness Detection
    • Compare
      • Compare & Liveness detection
      • Compare 1:1
    • Search
      • Search 1:N | Live
      • Search 1:N
      • Search 1:N | Crop
      • Face Detect
      • Face Verify
  • Scan Docs API's
    • Scan Studio
      • Documents supported
      • 🇨🇴[Example] Tarjeta de propiedad
    • Scan Prompt
      • Documents supported
      • Scan Prompt templates
  • Resources
    • Projects
      • The Project object
      • Create a project
      • Update a project
      • Retrieve a project
      • List all projects
    • Project Flows
      • The ProjectFlow object
      • Create a project flow
        • Login settings
        • Onboarding settings
        • Security settings
      • Update a project flow
      • Retrieve a project flow
      • List all project flows
    • App Logins
      • The AppLogin object
      • Create an app login
      • Retrieve an app login
      • List all app logins
    • App Registrations
      • The AppRegistration object
      • Create an app registration
      • Sync app registration status
      • Retrieve an app registration
      • List all app registrations
    • Credits
      • The Credit object
      • Retrieve a credit record
      • List all credit records
    • Document Validations
      • The DocumentValidation object
      • Enroll - Create Document Validation
      • Retrieve a document validation
      • List all document validations
      • Delete a document validation
    • Email Validations
      • The Email Validation object
      • Create Email Validation
      • Validate an Email Validation
      • Retrieve an Email Validation
      • List of Email Validations
    • Phone Validations
      • The Phone Validation object
      • Create Phone Validation
      • Validate Phone Validation
      • Retrieve a Phone Validation
      • List of Phone Validations
    • Collections
      • The Collection object
      • Create a Collection
      • Retrieve a Collection
      • List all Collection
    • Persons
      • The Person object
      • Create a Person
      • Create a Person [With Liveness detection]
      • Update a Person
      • Delete a Person
      • Retrieve a Person
      • List all Persons
    • Webhooks
      • The Webhook object
      • Create a Webhook
      • Update a Webhook
      • Delete a Webhook
      • Retrieve a Webhook
      • List all Webhooks
      • Webhook integration
    • Biometric Validations
      • The Biometric Validation Object
      • Create Biometric Validation
      • Validate Biometric Validation
      • Retrieve a Biometric Validation
      • List all Biometric Validations
  • Plans & Pricings
    • Database Screening plans
    • Smart Access Plans
      • Free Plans
      • Active Users
      • Sessions
      • Extra Charges
      • Enterprise Plans
    • SmartEnroll Plans
    • Enroll Plans
    • SMS/WhatsApp Pricing
  • Identity validation
    • 🇦🇷Argentina
    • 🇧🇴Bolivia
    • 🇧🇷Brazil
    • 🇨🇦Canada
      • 🇨🇦Ontario Driver license
      • 🇨🇦Quebec Driver license
      • 🇨🇦British Columbia license
    • 🇨🇱Chile
      • 🇨🇱Chilean taxpayer information
    • 🇨🇴Colombia
      • Colombian Citizen
      • Colombian Citizen with Extra Data
      • Special Stay Permit (PEP)
      • Temporary Protection Permit (PPT)
      • Colombian Foreigner ID (CE)
      • Colombian Politically Exposed Persons
    • 🇨🇷Costa Rica
    • 🇩🇴Dominican Republic
    • 🇪🇨Ecuador
    • 🇸🇻El Salvador
    • 🇬🇹Guatemala
    • 🇭🇳Honduras
    • 🇲🇽Mexican
    • 🇵🇦Panama
    • 🇵🇾Paraguay
    • 🇵🇪Peru
      • 🇵🇪[v3] Peruvian Citizen
      • 🇵🇪[v3] Full Peruvian Citizen
      • 🇵🇪Peruvian Citizen
      • 🇵🇪Peruvian Foreigner Resident
      • 🇵🇪Peruvian Citizen Information with Extra Data
    • 🇪🇸Spain Citizen
    • 🇺🇸United States
      • 🇺🇸SSN Verification (Social Security Number)
      • 🇺🇸Florida Driver License Validation
      • 🇺🇸Kansas Driver's License Verification
    • 🇺🇾Uruguay
    • 🇻🇪Venezuela
      • 🇻🇪Venezuelan Citizen Information
      • 🇻🇪Venezuelan Foreigner citizens
  • Vehicle Validation
    • 🇦🇷Argentina
    • 🇧🇴Bolivia
    • 🇧🇷Brazil
    • 🇨🇱Chile
      • 🇨🇱Vehicle Information
      • 🇨🇱Driver license
    • 🇨🇴Colombia
      • 🇨🇴Vehicle by Code - Fasecolda
      • 🇨🇴SIMIT Resolutions
      • 🇨🇴Complete vehicle with historical records by VIN - RUNT
      • 🇨🇴Information System for Drivers Transporting Dangerous Goods
      • 🇨🇴Vehicle's SOAT and RTM by Plate and Identification document
      • 🇨🇴General query of SIMIT by license plate
      • 🇨🇴Driver's License
      • 🇨🇴Vehicle by plate and identification card only
      • 🇨🇴Vehicle Values by Plate - Fasecolda
      • 🇨🇴Verifik Pico y Placa for Bogotá
      • 🇨🇴Complete vehicle with historical records by plate and identification document - RUNT
      • 🇨🇴SIMIT Agreements
      • 🇨🇴SIMIT Fines
      • 🇨🇴General query of SIMIT by Identification Document
      • 🇨🇴Sinister Verification - Fasecolda
      • 🇨🇴Vehicle Fines Check in Bogotá, Colombia
      • 🇨🇴Taxes in Bogota
      • 🇨🇴Vehicle accidentality in Bogota
    • 🇨🇷Costa Rica
    • 🇪🇨Ecuador
      • 🇪🇨Ecuador Vehicle Fines
      • 🇪🇨Vehicle Information Lookup
    • 🇲🇽Mexico
    • 🇵🇾Paraguay
    • 🇵🇪Peru
      • 🇵🇪Peruvian Vehicle
      • 🇵🇪Peruvian Vehicle Insurance
    • 🇺🇸United States
      • 🇺🇸Vehicle Information
      • 🇺🇸Vehicle Information by VIN
  • Business Validation
    • 🇦🇷Argentina
    • 🇧🇴Bolivia
    • 🇧🇷Brazil
    • 🇨🇦Canada
    • 🇨🇱Chilean
    • 🇨🇴Colombia
      • 🇨🇴Colombian Business Information - RUES
      • 🇨🇴Complete Business Registry - RUES
      • 🇨🇴Colombian Company DIAN Verification
      • 🇨🇴Verify Legal Invoicer in DIAN for Colombian Companies
    • 🇨🇷Costa Rica
    • 🇲🇽Mexico
    • 🇵🇦Panama
    • 🇵🇾Paraguay
    • 🇵🇪Peru
    • 🇪🇸Spain
    • 🇺🇸United States
  • Background Check
    • 🇧🇷Brazil
    • 🇨🇴Colombia
      • 🇨🇴Public Contracts
      • 🇨🇴Colombian Police Record Check
      • 🇨🇴Verify Police Compliance with Corrective Measures
      • 🇨🇴Comptroller Certificate
      • 🇨🇴Disciplinary Records in Colombia (attorney's office)
    • 🌎International
      • 🌎DEA Background Check
      • 🌎Europol Background Check
      • 🌎FBI Background Check
      • 🌎Interpol Background Check
      • 🌎OFAC Background Check
      • 🌎ONU Background Check
  • Military
    • 🇨🇴Colombia
  • Finance
    • 🇨🇴Delinquent debtors
  • Legal
    • 🇨🇴Lawyer Verification
    • 🇨🇴Colombian Legal Processes
    • 🇨🇴Retrieve Details of a Legal Process by Number
    • 🇨🇴Court Case Records Lookup
    • 🇨🇴Certificate of Validity for Legal Professionals
  • Certificates
    • 🇨🇴Registry Certificate
    • 🇨🇴High Altitude Job Eligibility
    • 🇨🇴SENA Certificates
  • Voting
    • 🇨🇴Retrieve Voting Information for Colombian Citizens
  • Health
    • 🇨🇴Colombian RETHUS Verification Data
    • 🇨🇴Verify Colombian Affiliations
  • Verifik LLC
    • Privacy Policy
    • Políticas de Privacidad
    • Términos y Condiciones
    • Terms and Conditions
    • Acuerdo de Niveles de Servicio
    • Service Level Agreement
    • Verifik for Enterprises HUB (Esp)
    • Verifik for Enterprises HUB (Eng)
    • SmartCheck Terms and Conditions of Use
Powered by GitBook
On this page
  • Configuration
  • ProjectFlow Setup
  • Let's get started
  • Configuration
  • Email Validation
  • Phone Validation
  • Document Validation
  • Biometric Validation
  1. Services
  2. Enroll

Tutorial

Enroll tutorial via API

PreviousEnrollNextSmart Scan

Last updated 4 months ago

Configuration

If you haven't created a project and a projectFlow with the property type = onboarding, then here there are the links for that.

ProjectFlow Setup

{
    "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": "miguel@verifik.co"
    }
}
{
    "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": "miguel@verifik.co"
    }
}

Let's get started

The flow mainly starts with the creation of the AppRegistration then we proceed with the creation of the email validation/phone validation (depending on the configuration inside the ProjectFlow) which will grant us access to either redirect the user and complete the record without the KYC process or we continue with the next validations which starts with the document validation and then the liveness detection so we can later on do a comparison of the document photo and the selfie that was taken.

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
},

Email Validation

Every validation starts by initiating it with the params that are required to get triggered, in the case of the email, we require the email address so the user can receive the one time password

Once the email is sent, the user will receive a 6-digit One Time Password (OTP). They must enter this OTP in the UI or submit it to the following API endpoint.


Phone Validation

If the AppRegistration needs to validate the phone as well, we will have to repeat the same process with some changes, for the phone validation it's required to pass the phoneGateway (sms, whatsapp) and the countryCode, and the phone.

After the SMS or WhatsApp message is sent, the user will receive a 6-digit One Time Password (OTP). They must enter this OTP in the UI or submit it to the following API endpoint.

Document Validation

If the AppRegistration needs to validate a legal document, we will have to create a documentValidation which will require a photo of the document to extract the information with our OCR system and we will determinate if the document requires a back side or the document is completed with just the front side.

Biometric Validation

If the AppRegistration needs to validate the liveness of the person we will require to create a biometricValidation which will require a selfie of the person doing the enrollment and we will perform several checks, such as 1:N search to find duplicates and also a liveness detection score will be assigned to the record and it will be compared to the minimum liveness score that the projectFlow has in the liveness configuration.

First we will start by initiating it so we can perform a validation next.

After we have a session, we will use that session to perform the selfie extraction and we will accept a base64 image which will be passed to our liveness detection model and it will return a score

Create a project
Create a project flow
Create an app registration
Create Email Validation
Validate an Email Validation
Create Phone Validation
Validate Phone Validation
Enroll - Create Document Validation
Create Biometric Validation
Validate Biometric Validation