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
  • Endpoint
  • Params
  • Request
  • Response
  • Response Details
  1. Resources
  2. Biometric Validations

Create Biometric Validation

Endpoint

https://api.verifik.co/v2/biometric-validations

This endpoint is used to create a new biometric validation. The biometric validation is used to control the whole process of searching someone in the project (1:N) and then authenticating/onboarding the user depending on the flow they are trying to perform. Creating a biometric validation may include the type (login, onboarding).

Params

Parameter
Type
Description
Required

project

string

The unique identifier for the project.

Yes

projectFlow

string

The unique identifier for the project flow.

Yes

identifier

string

The unique identifier for the client (user) being validated.

Yes

type

string

The type of biometric validation (e.g., "login").

Yes

Request

curl --location --request POST 'https://api.verifik.co/v2/biometric-validations' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
    "project": "66df5bf5c4d855fb0bdf5da2",
    "projectFlow": "66df5c22c4d855fb0bdf5da9",
    "identifier": "03da12fba",
    "type": "login"
}'
const axios = require('axios');

let data = JSON.stringify({
  "project": "66df5bf5c4d855fb0bdf5da2",
  "projectFlow": "66df5c22c4d855fb0bdf5da9",
  "identifier": "03da12fba",
  "type": "login"
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.verifik.co/v2/biometric-validations',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer <token>'
  },
  data : data
};

axios.request(config)
  .then((response) => {
    console.log(JSON.stringify(response.data));
  })
  .catch((error) => {
    console.log(error);
  });

Response

{
    "data": {
        "livenessSession": {
            "client": "613375a1eab2fe08527f81e2",
            "project": "66df5bf5c4d855fb0bdf5da2",
            "projectFlow": "66df5c22c4d855fb0bdf5da9",
            "identifier": "03da12fba",
            "status": "active",
            "livenessResult": [],
            "comparisonResult": [],
            "generalInformation": [],
            "documentTypeFields": [],
            "location": [],
            "proFields": [],
            "studioFields": [],
            "promptFields": [],
            "expiresAt": "2024-09-12T17:30:26.000Z",
            "_id": "66e3244269cd15b505d21063",
            "activatedAt": "2024-09-12T17:26:26.954Z",
            "updatedAt": "2024-09-12T17:26:26.964Z",
            "createdAt": "2024-09-12T17:26:26.964Z",
            "__v": 0
        },
        "biometricValidation": {
            "client": "613375a1eab2fe08527f81e2",
            "project": "66df5bf5c4d855fb0bdf5da2",
            "projectFlow": "66df5c22c4d855fb0bdf5da9",
            "livenessSession": "66e3244269cd15b505d21063",
            "status": "new",
            "type": "login",
            "url": "https://app.verifik.co/sign-in/66df5bf5c4d855fb0bdf5da2?type=liveness",
            "livenessScore": 0,
            "assignedCollection": "66df5bf5c4d855fb0bdf5da4",
            "collectionCode": "d29fe454-3ecc-4f58-8666-4021ac575d9c",
            "requires2FA": false,
            "_id": "66e3244369cd15b505d21065",
            "updatedAt": "2024-09-12T17:26:27.068Z",
            "createdAt": "2024-09-12T17:26:27.068Z",
            "__v": 0
        },
        "token": "eyJhbGciOiJIUzI1kpXVCJ9.eyJsaXZlbmVO3j1...1ewV1cNFR8je4U"
    }
}
{
    "code": "MissingParameter",
    "message": "type must be one of: [validation,login,onboarding,oneTimeLink]"
}

Response Details

  • livenessSession: The data for the liveness session created as part of this biometric validation.

    • client: The unique identifier for the client.

    • project: The project ID associated with the biometric validation.

    • projectFlow: The flow ID for this project.

    • identifier: The unique identifier for the session.

    • status: The status of the liveness session (e.g., "active").

    • livenessResult: Any results from the liveness check (array).

    • comparisonResult: Any results from biometric comparisons (array).

    • generalInformation: Any general information related to the session (array).

    • expiresAt: The expiry timestamp for the session.

    • activatedAt: The activation timestamp for the session.

    • updatedAt: The last updated timestamp.

    • createdAt: The creation timestamp.

    • _id: The unique identifier for the liveness session.

  • biometricValidation: The data for the biometric validation itself.

    • client: The client ID for this validation.

    • project: The project ID for this validation.

    • projectFlow: The flow ID for this validation.

    • livenessSession: The associated liveness session ID.

    • status: The status of the biometric validation (e.g., "new").

    • type: The type of validation (e.g., "login").

    • url: A URL related to the biometric validation, typically for a liveness check.

    • livenessScore: The score from the liveness check.

    • assignedCollection: The collection ID assigned to this validation.

    • collectionCode: A unique collection code.

    • requires2FA: A boolean indicating whether the validation requires 2FA (Two-Factor Authentication).

    • createdAt: The creation timestamp for the validation.

    • updatedAt: The last updated timestamp for the validation.

    • _id: The unique identifier for the biometric validation.

  • token: A JWT token associated with the liveness session, containing an expiration timestamp and other information.

PreviousThe Biometric Validation ObjectNextValidate Biometric Validation

Last updated 4 months ago