Veriglobe API Documentation

Getting Started

This documentation will help you integrate Veriglobe's identity verification services into your application. If you need any assistance, please contact our support team.

The Veriglobe API provides a comprehensive suite of identity verification services, allowing developers to integrate KYC (Know Your Customer) functionality into their applications.

Our API enables you to verify various forms of identification including Bank Verification Numbers (BVN), National Identification Numbers (NIN), identity documents, and address information.

Generate KYC Link

Create a verification session and get a link for your customers to complete verification.

Retrieve User Data

Access comprehensive verification data for your customers after they complete the process.

List Verifications

View all verification sessions for your projects and track their status.

Base URL

https://api.veriglobe.net/

API Flow

Generate a KYC link for your customer and store the verification_id
Customer completes verification through the provided link
Receive verification results via callback or retrieve them via API using the verification_id

Authentication

All API requests require authentication using API keys. Include your API keys in the request headers:

Public-Key: YOUR_PUBLIC_KEY
Private-Key: YOUR_PRIVATE_KEY

You can obtain your API keys from the Veriglobe dashboard under API & Settings.

Security Notice

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, etc.

Security Best Practices

Never expose your private key in client-side code or public repositories
Always use HTTPS for API calls to ensure data is encrypted in transit
Rotate your API keys periodically to minimize security risks
Implement proper error handling for authentication failures

Generate KYC Link

Endpoint Overview

This endpoint creates a verification session and returns a link that can be used to complete the verification process. The response includes both the verification_id and the KYC link.

POST index.php/generate_kyc_link

Headers

Content-Type
application/json
Public-Key
Your public API key
Private-Key
Your private API key

Request Body

project_id Required
Your project ID
customer_name Required
The name of the customer to verify
callback_url Required
URL to receive verification results

{
  "project_id": "YOUR_PROJECT_ID",
  "customer_name": "John Doe",
  "callback_url": "https://your-website.com/callback"
}

{
  "verification_id": "123",
  "kyc_link": "https://verify.veriglobe.net?verification_id=123&project_id=456&customer_name=John%20Doe"
}

Tip

Store the verification_id in your database. You'll need it later to retrieve the verification results.

Retrieve User Data

Retrieves the verification data for a completed verification.

POST index.php/user_data

Headers

Content-Type
application/json
Public-Key
Your public API key
Private-Key
Your private API key

Request Body

verification_id Required
The ID of the verification to retrieve
project_id Required
Your project ID

Example Request

{
  "verification_id": "VERIFICATION_ID",
  "project_id": "YOUR_PROJECT_ID"
}

Response

{
  "user_data": {
    "verification_id": "123",
    "customer_name": "John Doe",
    "bvn_status": "Verified",
    "nin_status": "Verified",
    "identity_status": "Verified",
    "address_status": "Verified",
    "bvn": "12345678901",
    "nin": "12345678901",
    "user_picture_url": "https://example.com/uploads/user_123.jpg",
    "id_picture_url": "https://example.com/uploads/id_123.jpg",
    "address": "123 Main Street, Lagos, Nigeria",
    "verification_time_seconds": 120,
    "verdict": "Completed"
  }
}

Get User Data

Retrieves comprehensive data about a verified user. This endpoint is particularly useful for mobile applications that need to display detailed information about users who have completed the verification process.

POST index.php/get_user_data

Headers

Content-Type
application/json
Public-Key
Your public API key
Private-Key
Your private API key

Request Body

verification_id Required
The ID of the verification to retrieve data for

Example Request

{
  "verification_id": "VERIFICATION_ID"
}

Response

{
  "user_data": {
    "verification_id": "123",
    "project_id": "456",
    "customer_name": "John Doe",
    "nin_status": "Verified",
    "bvn_status": "Verified",
    "address_status": "Verified",
    "identity_status": "Verified",
    "verdict": "Completed",
    "verification_time_seconds": 120,
    "verification_date": "2023-01-01 12:00:00",
    "nin": "12345678901",
    "bvn": "12345678901",
    "address": "123 Main Street, Lagos, Nigeria",
    "user_picture_url": "https://example.com/uploads/user_123.jpg",
    "id_picture_url": "https://example.com/uploads/id_123.jpg"
  }
}

List Verifications

Retrieves a list of verifications for a specific project. This endpoint is particularly useful for mobile applications to find the verification_id for a specific customer.

POST index.php/list_verifications

Headers

Content-Type
application/json
Public-Key
Your public API key
Private-Key
Your private API key

Request Body

project_id Required
The ID of the project to list verifications for
limit Optional
Maximum number of verifications to return (default: 100)
offset Optional
Number of verifications to skip (default: 0)

Example Request

{
  "project_id": "YOUR_PROJECT_ID",
  "limit": 100,
  "offset": 0
}

Response

{
  "verifications": [
    {
      "verification_id": "123",
      "customer_name": "John Doe",
      "nin_status": "Verified",
      "bvn_status": "Verified",
      "address_status": "Verified",
      "identity_status": "Verified",
      "verdict": "Completed",
      "created_at": "2023-01-01 12:00:00"
    },
    {
      "verification_id": "124",
      "customer_name": "Jane Smith",
      "nin_status": "Verified",
      "bvn_status": "Verified",
      "address_status": "Pending",
      "identity_status": "Verified",
      "verdict": "Pending Manual Review",
      "created_at": "2023-01-02 14:30:00"
    }
  ]
}