Virtual NIN (VNIN)

curl --request POST \
  --url https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/vnin/ \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "vnin": "WB9D9SE8HA41Z2M0"
}
'

import requests

url = "https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/vnin/"

payload = { "vnin": "WB9D9SE8HA41Z2M0" }
headers = {
    "x-access-token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({vnin: 'WB9D9SE8HA41Z2M0'})
};

fetch('https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/vnin/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/vnin/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'vnin' => 'WB9D9SE8HA41Z2M0'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-access-token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/vnin/"

	payload := strings.NewReader("{\n  \"vnin\": \"WB9D9SE8HA41Z2M0\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-access-token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/vnin/")
  .header("x-access-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"vnin\": \"WB9D9SE8HA41Z2M0\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/vnin/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"vnin\": \"WB9D9SE8HA41Z2M0\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": "failed",
  "data": [
    "<unknown>"
  ],
  "message": "<string>"
}

{
  "status": "failed",
  "message": "Authentication credentials were not provided."
}

POST

api

onboarding

nigeria_kyc

vnin

Virtual NIN (VNIN)

curl --request POST \
  --url https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/vnin/ \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "vnin": "WB9D9SE8HA41Z2M0"
}
'

import requests

url = "https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/vnin/"

payload = { "vnin": "WB9D9SE8HA41Z2M0" }
headers = {
    "x-access-token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({vnin: 'WB9D9SE8HA41Z2M0'})
};

fetch('https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/vnin/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/vnin/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'vnin' => 'WB9D9SE8HA41Z2M0'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-access-token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/vnin/"

	payload := strings.NewReader("{\n  \"vnin\": \"WB9D9SE8HA41Z2M0\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-access-token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/vnin/")
  .header("x-access-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"vnin\": \"WB9D9SE8HA41Z2M0\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/vnin/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"vnin\": \"WB9D9SE8HA41Z2M0\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": "failed",
  "data": [
    "<unknown>"
  ],
  "message": "<string>"
}

{
  "status": "failed",
  "message": "Authentication credentials were not provided."
}

The VNIN endpoint validates a Virtual National Identification Number — a tokenised version of a customer’s NIN generated by NIMC — and returns their core identity profile.

Endpoint

POST /api/onboarding/nigeria_kyc/vnin/

Request

Headers

Header	Value	Required
`x-access-token`	Your API secret key	Yes
`Content-Type`	`application/json`	Yes

Body Parameters

Parameter	Type	Required	Description
`vnin`	string	Yes	The customer’s 16-character Virtual NIN (e.g., `AB012345678910YZ`)

Example

curl -X POST "https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/vnin/" \
  -H "x-access-token: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"vnin": "AB012345678910YZ"}'

import requests
response = requests.post(
    "https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/vnin/",
    headers={"x-access-token": "YOUR_SECRET_KEY", "Content-Type": "application/json"},
    json={"vnin": "AB012345678910YZ"},
)

Response

200 OK

Field	Type	Description
`data.vnin`	string	The VNIN that was queried
`data.firstname`	string	First name
`data.middlename`	string	Middle name
`data.lastname`	string	Last name
`data.gender`	string	`"M"` or `"F"`
`data.mobile`	string	Registered mobile number
`data.photo`	string	Base64-encoded customer photo
`data.customer`	string	Unique customer reference UUID

{
  "status": "success",
  "data": {
    "vnin": "AB012345678910YZ",
    "firstname": "John",
    "middlename": "Doe",
    "lastname": "Alamutu",
    "gender": "M",
    "mobile": "08012345678",
    "photo": "<base64-encoded-jpeg>",
    "customer": "6bb82c41-e15e-4308-b99d-e9640818eca9"
  },
  "message": "Virtual National Identification Number details retrieved successfully"
}

400 Bad Request

{
  "status": "failed",
  "data": [],
  "message": "VNIN is required"
}

401 Unauthorized

{
  "status": "failed",
  "message": "Authentication credentials were not provided."
}

Authorizations

x-access-token

string

header

required

Your Adhere API secret key

Body

application/json

vnin

string

required

16-character Virtual NIN

Example:

"WB9D9SE8HA41Z2M0"

Response

VNIN verified

​Endpoint

​Request

​Headers

​Body Parameters

​Example

​Response

​200 OK

​400 Bad Request

​401 Unauthorized

Authorizations

Body

Response

Endpoint

Request

Headers

Body Parameters

Example

Response

200 OK

400 Bad Request

401 Unauthorized