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
      • 🇨🇴Colombian Politically Exposed Persons
      • 🇨🇴Special Stay Permit (PEP) ID
      • 🇨🇴Colombian Foreigner ID (CE)
    • 🇨🇷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
      • 🌎Interpol Background Check
      • 🌎OFAC Background Check
      • 🌎Europol Background Check
      • 🌎FBI Background Check
      • 🌎ONU Background Check
      • 🌎DEA 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
  • Headers
  • Parameters
  • Request
  • Response
  • Response Details
  1. Resources
  2. Biometric Validations

Validate Biometric Validation

Endpoint

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

This endpoint is used to validate a biometric session based on liveness results or image data. The validation checks if the provided biometric data (such as an image) corresponds to the active session.

Headers

Parameter
Type
Description

Authentication

string

Parameters

Parameter
Type
Description
Required

image

string

Base64 encoded image data used for biometric validation.

Yes

os

string

The operating system of the client device (e.g., "ios", "android").

Yes

Request

curl --location --request POST 'https://api.verifik.co/v2/biometric-validations/validate' \
--header 'Authorization: Bearer <JWT token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "image": "/9j/4AAQSkZJRgABAQAAAQABAAD...",
    "os": "ios"
}'
const axios = require('axios');

let data = JSON.stringify({
  "image": "/9j/4AAQSkZJRgABAQAAAQABAAD...",
  "os": "ios"
});

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

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

Response

{
    "data": {
        "appLogin": {
            "_id": "66e3338e90c120bf345a1dcc",
            "client": "613375a1eab2fe08527f81e2",
            "name": "Carlos Bleck",
            "status": "validated",
            "project": "6266193db77ccc8111730c90",
            "projectFlow": "658ed28b0990f300134d7b78",
            "type": "faceLiveness",
            "biometricValidation": "66e3338e90c120bf345a1dca",
            "updatedAt": "2024-09-12T18:32:17.224Z",
            "createdAt": "2024-09-12T18:31:42.723Z",
            "__v": 0,
            "face": "66e333b090c120bf345a1ddf"
        },
        "livenessSession": {
            "_id": "66e3338e90c120bf345a1dc8",
            "client": "613375a1eab2fe08527f81e2",
            "project": "6266193db77ccc8111730c90",
            "projectFlow": "658ed28b0990f300134d7b78",
            "identifier": "03da12fba",
            "status": "active",
            "livenessResult": [],
            "comparisonResult": [],
            "generalInformation": [],
            "documentTypeFields": [],
            "location": [],
            "proFields": [],
            "studioFields": [],
            "promptFields": [],
            "expiresAt": "2024-09-12T18:35:42.000Z",
            "activatedAt": "2024-09-12T18:31:42.524Z",
            "updatedAt": "2024-09-12T18:31:42.526Z",
            "createdAt": "2024-09-12T18:31:42.526Z",
            "__v": 0
        },
        "person": "6633eabb0ced0451db577393",
        "token": "eyJhbGciOiJIUCI6IkpXVCJ9.eyJpZ...CI6wIZLtiM8"
    },
    "signature": {
        "dateTime": "September 12, 2024 6:32 PM",
        "message": "Certified by Verifik.co"
    },
    "id": "K5B3J"
}
{
    "code": "InvalidCredentials",
    "message": "caused by JsonWebTokenError: invalid signature"
}

Response Details

  • data.appLogin: Details about the login session created for the app:

    • _id: The unique identifier for the login session.

    • client: The unique identifier for the client.

    • name: The name of the person validated.

    • status: The current status of the session (e.g., "validated").

    • project: The ID of the project associated with this validation.

    • projectFlow: The flow ID for the project.

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

    • biometricValidation: The ID of the biometric validation used.

    • updatedAt: The timestamp when the session was last updated.

    • createdAt: The timestamp when the session was created.

    • face: The ID of the face validation associated with this session.

  • data.livenessSession: Details about the liveness session used for validation:

    • _id: The unique identifier for the liveness session.

    • client: The unique identifier for the client.

    • project: The project ID associated with the session.

    • identifier: The session identifier.

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

    • livenessResult: Results of the liveness check (array).

    • expiresAt: The expiry timestamp for the session.

    • createdAt: The timestamp when the session was created.

    • updatedAt: The timestamp when the session was last updated.

  • data.person: The ID of the person involved in the biometric validation.

  • data.token: A JWT token associated with the session.

  • signature: A signature confirming the biometric validation was certified by Verifik.

    • dateTime: The date and time the validation was certified.

    • message: The certification message.

PreviousCreate Biometric ValidationNextRetrieve a Biometric Validation

Last updated 4 months ago

The JWT token you got from the

Creation of the Biometric Validation