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
      • 🇨🇦British Columbia license
    • 🇨🇱Chile
      • 🇨🇱Chilean Citizen Information
      • 🇨🇱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
    • 🇻🇪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
  • API Requests in Verifik
  • Conclusion
  1. Services
  2. SmartCheck

App Query example

PreviousSmartCheckNextSmartAccess

Last updated 8 months ago

API Requests in Verifik

Verifik provides a powerful, no-code interface to validate people, businesses, vehicles, and more, across multiple countries. The platform offers a range of API endpoints that users can query to obtain various data points related to identity verification, business validation, vehicle registration checks, and even background screenings. Here’s a step-by-step guide on how to make API requests within the Verifik platform:


1. Choosing an API Endpoint

  • Search the API Here: Start by selecting the type of validation you want to perform (person, business, or vehicle) by using the search bar. You can search by country and category (e.g., Identity, Background Check, Business Validation).

  • API Endpoints List: The left sidebar provides a list of available API endpoints for validation. Each endpoint is labeled with:

    • A country flag (indicating which country's data it pulls from).

    • The type of service it offers (Identity, Background Check, Business Validation, etc.).

    • The cost per query (e.g., $0.05 per request). The price it all depends on the plan you currently have in your account. Starting price is $0.20 per API Request.

  • Select Your API: For example, if you want to validate a Colombian citizen, you can select the Colombian Citizen Information API (/v2/co/cedula), which retrieves identification details such as full name and identification number.


2. Enter Input Parameters

  • Document Type: Once you’ve selected an API, input fields will appear. For identity verification APIs, you will typically need to enter a document type (e.g., CC for Colombian Cedula).

  • Document Number: Enter the citizen’s document number in the field provided (e.g., 1023942106).

  • Add More Queries: You can add multiple queries to your list by selecting the “+ Add” button, allowing you to validate multiple people or documents in a single session.

Dynamic Lists via API: The system dynamically handles lists, so when you add a document number or any data to be validated, Verifik immediately queues this request in your session. This dynamic handling allows you to validate large lists quickly and efficiently.


3. Viewing the Cart and Cost

  • Cart Overview: Once you’ve added one or more queries, the total cost for your requests is displayed on the right sidebar. You can review all queued API calls here.

    • Each API request shows the document number or input data you are querying.

    • The price per API call is clearly indicated, allowing you to keep track of the total cost.

  • Erase All: If you want to remove all entries before proceeding, you can clear your cart by clicking the Erase all button.

  • Proceed with Query: Once ready, click the Query button to execute the API calls and retrieve the data.


4. Results and Response Data

  • Consulted Services: After submitting the queries, the system returns results in the Consultation Report. For each document or validation request:

    • The API endpoint used (e.g., /v2/co/cedula).

    • The input parameters (e.g., Document Number and Document Type).

    • Results, including the person’s full name and document verification status.

  • No-code and JSON Views: The results can be viewed in two formats:

    • No-code View: This presents the results in a human-readable table format.

    • JSON View: If you want to access the raw data or use it in your systems, the response is available in JSON format, which is useful for integrating results into your own applications or platforms.

Key Information Returned:

  • Full Name: The full legal name associated with the document number.

  • Document Number: The unique ID number provided.

  • Date of Birth and Expedition Date: Some APIs may return private or semi-private data, such as birth dates, document issue dates, or additional details related to the document’s authenticity.


Supported Countries and Categories

Verifik’s API platform supports a wide range of countries and validation categories:

  • Countries Supported: You can select different countries for your validation queries, including Colombia, Mexico, the United States, and more. The system dynamically lists all available APIs based on the selected country.

  • Validation Categories:

    • Identity Verification: Verify individuals using national identification systems.

    • Background Checks: Check for criminal records, watchlist status, and more.

    • Business Validation: Verify the legitimacy of registered businesses, their legal status, and public filings.

    • Vehicle Validation: Retrieve information on vehicle registrations, ownership, and legal statuses.


Example of API Integration Code

For developers looking to integrate Verifik's API services into their own applications, here is an example of the JavaScript (Axios) code to perform an API request:

import axios from 'axios';

const options = {
  method: 'GET',
  url: 'https://api.verifik.co/v2/co/cedula',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer YOUR_API_KEY',
  },
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error('Error making the request:', error);
}

How it Works:

  • Authorization: Each request to the Verifik API requires a valid JWT token in the headers.

  • Endpoint: The API URL specifies the country and type of data you’re querying (in this example, /v2/co/cedula is for Colombian Citizen Information).

  • Response: The API will return a structured JSON response with the queried person’s data, which can be handled as needed by your application.


Conclusion

Verifik’s platform offers a seamless no-code and API-driven solution for validating people, businesses, and vehicles across multiple countries. Whether you need real-time identity checks, business registrations, or background checks, Verifik’s dynamic API system adapts to your needs, allowing for fast, scalable validation processes that integrate with your existing systems.

This guide should help users, developers, and organizations to quickly get started with Verifik’s powerful API suite for their KYC and compliance needs.