Skip to main content
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"
}
'
{
  "status": "failed",
  "data": [
    "<unknown>"
  ],
  "message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.smartcomply.com/llms.txt

Use this file to discover all available pages before exploring further.

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

HeaderValueRequired
x-access-tokenYour API secret keyYes
Content-Typeapplication/jsonYes

​
Body Parameters

ParameterTypeRequiredDescription
vninstringYesThe 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"}'

​
Response

​
200 OK

FieldTypeDescription
data.vninstringThe VNIN that was queried
data.firstnamestringFirst name
data.middlenamestringMiddle name
data.lastnamestringLast name
data.genderstring"M" or "F"
data.mobilestringRegistered mobile number
data.photostringBase64-encoded customer photo
data.customerstringUnique 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