Introduction Last updated: 2023-11-25

Welcome to the Quickverify API documentation! This comprehensive guide is designed to assist developers in integrating and utilizing our robust verification services seamlessly. Our API empowers your applications with the capability to perform various verifications, including National Identification Number (NIN), Corporate Affairs Commission (CAC) details, Tax Identification Number (TIN), Bank Verification Number (BVN), and more..

Getting Started

1. Login or Create an Account: Input your details on quickverify.com.ng/signin to either login or sign up as a customer if you have no account already.

2. Retrieve your API keys: When you integrate with our services, you will need to authenticate using your api key. Go to your profile page, navigate to API keys and copy the key to make your first API call.

3. Fund your wallet: Top up your wallet to avoid service disruption. You can fund your wallet on your portal via bank transfer or online payment.

Response Codes & Status

When using the Quickverify API, you may encounter custom response codes that indicate the status of a particular request. These custom response codes are as follows:

00	Successful	This code indicates that the request was successful and that the expected data has been returned.
01	Record not found	This code indicates that the ID provided in the request was not found in the system.
02	Service is not available	This code indicates that the requested service is unavailable. This could be due to maintenance, downtime, or other issues.

It is important to note that custom response codes only compliments the standard HTTP response.

Response Structure

 
	{
		"status": false,
		"response_code": "01",
		"message": "Record not found",
		"verification": {
			"reference": "254d1801-db5d-450a-954b-3682ddae7072"
		},
		"session": {}
	}
	
	
	{
		"status": false,
		"detail": "Verification failed",
		"response_code": "02",
		"message": "Verification can't be completed at this time. Kindly retry later",
		"verification": {
			"reference": ""
		},
		"session": {}
	}

Authentication

Quickverify authentication mechanism relies on just one type of key.

All API calls on Quickverify can be executed using the secret key. No other Authorization header should be implemented when calling Quickverify's API endpoints

Need Assistance?

This documentation may not be as clear as we hoped. We encourage you to contact us so we can be sure your needs are being met! You can contact us on developer@quickverify.com.ng

Glad to have you here!

Verifications

NIN Search

Get NIN data with NIN number

POST

https://api.quickverify.com.ng/verification/nin-search

Request Header

Key	Description
x-api-key	Your API Key

Request Body

Key	Description
nin	The national identity number

Example Request (curl)

 
  curl --location --request POST 'https://api.quickverify.com.ng/verification/nin-search' \
  --header 'x-api-key: xxxxxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "nin":"1234567890"
  }'

Example Response

 
  {
	"status": true,
	"data": {
		"birthdate": "10-12-1994",
		"email": "email@yahoo.com",
		"emplymentstatus": "self employed",
		"firstname": "Abania",
		"gender": "f",
		"maritalstatus": "single",
		"middlename": "Ariwola",
		"nin": "12345678901",
		"photo": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0a\nHBwgJC4...",
		"profession": "BUSINESS",
		"religion": "christianity",
		"residence_AdressLine1": "11 TUNAKIA STREET BARUWA",
		"residence_Town": "Abuna",
		"residence_lga": "Ananbis",
		"residence_state": "Abuja",
		"residencestatus": "birth",
		"signature": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDA\nRRRRRRRRRRRRRRRRRRRR\kdfgdknfgdfksdf\nRRRRRRRRXdfs...",
		"surname": "AHMED",
		"telephoneno": "12345678901",
		"title": "miss",
		"trackingId": "123456789"
	}
  }

NIN Phone Search

Get NIN data with NIN phone number

POST

https://api.quickverify.com.ng/verification/nin-phone

Request Header

Key	Description
x-api-key	Your API Key

Request Body

Key	Description
phone	Phone no to use to get the NIN

Example Request (curl)

 
  curl --location --request POST 'https://api.quickverify.com.ng/verification/nin-phone' \
  --header 'x-api-key: xxxxxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "phone":"09011112222"
  }'

Example Response

 
  {
	"status": true,
	"data": {
		"birthdate": "10-12-1994",
		"email": "email@yahoo.com",
		"emplymentstatus": "self employed",
		"firstname": "Abania",
		"gender": "f",
		"maritalstatus": "single",
		"middlename": "Ariwola",
		"nin": "12345678901",
		"photo": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0a\nHBwgJC4...",
		"profession": "BUSINESS",
		"religion": "christianity",
		"residence_AdressLine1": "11 TUNAKIA STREET BARUWA",
		"residence_Town": "Abuna",
		"residence_lga": "Ananbis",
		"residence_state": "Abuja",
		"residencestatus": "birth",
		"signature": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDA\nRRRRRRRRRRRRRRRRRRRR\kdfgdknfgdfksdf\nRRRRRRRRXdfs...",
		"surname": "AHMED",
		"telephoneno": "12345678901",
		"title": "miss",
		"trackingId": "123456789"
	}
  }

NIN Demography Search

Get NIN data with NIN phone number

POST

https://api.quickverify.com.ng/verification/nin-demography

Request Header

Key	Description
x-api-key	Your API Key

Request Body

Key	Description
firstname	First name on the NIN
lastname	Last name on the NIN
gender	Gender of the NIN Owner
dob	DOB (dd-mm-yyyy) Of the NIN Owner

Example Request (curl)

 
  curl --location --request POST 'https://api.quickverify.com.ng/verification/nin-demography' \
  --header 'x-api-key: xxxxxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "firstname":"Oluwasegun",
    "lastname":"Adio",
    "gender":"male",
    "dob":"30-01-1990"
  }'

Example Response

 
  {
	"status": true,
	"data": {
		"birthdate": "10-12-1994",
		"email": "email@yahoo.com",
		"emplymentstatus": "self employed",
		"firstname": "Abania",
		"gender": "f",
		"maritalstatus": "single",
		"middlename": "Ariwola",
		"nin": "12345678901",
		"photo": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0a\nHBwgJC4...",
		"profession": "BUSINESS",
		"religion": "christianity",
		"residence_AdressLine1": "11 TUNAKIA STREET BARUWA",
		"residence_Town": "Abuna",
		"residence_lga": "Ananbis",
		"residence_state": "Abuja",
		"residencestatus": "birth",
		"signature": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDA\nRRRRRRRRRRRRRRRRRRRR\kdfgdknfgdfksdf\nRRRRRRRRXdfs...",
		"surname": "AHMED",
		"telephoneno": "12345678901",
		"title": "miss",
		"trackingId": "123456789"
	}
  }

TIN Verification

Verify tax identification number

POST

https://api.quickverify.com.ng/verification/tin

Request Header

Key	Description
x-api-key	Your API Key

Request Body

Key	Description
tin	Tax IdentificationNumber To Be Verified

Example Request (curl)

 
  curl --location --request POST 'https://api.quickverify.com.ng/verification/tin' \
  --header 'x-api-key: xxxxxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "tin":"1234567"
  }'

Example Response

 
 {
    "status": true,
    "detail": "TIN Verification Successful",
    "response_code": "00",
    "data": {
        "taxpayer_name": "test test",
        "cac_reg_number": "Rc323479",
        "firstin": "12392112349",
        "jittin": "10001",
        "tax_office": "yaba tax office",
        "phone_number": "08082838487",
        "email": "test@teyst.com"
    }
  }

VNIN Verification

Verify Virtual National Identification Number

POST

https://api.quickverify.com.ng/verification/vnin

NOTE

The Virtual NIN (vNIN) is designed to replace the raw 11-digit NIN for everyday usage. To generate a VNIN, dial *346*3*customer NIN*696739#

Request Header

Key	Description
x-api-key	Your API Key

Request Body

Key	Description
vnin	Virtual National Identification Number to be verified

Example Request (curl)

 
  curl --location --request POST 'https://api.quickverify.com.ng/verification/vnin' \
  --header 'x-api-key: xxxxxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "vnin":"AA1234567890123B"
  }'

Example Response

 
  {
    "status": true,
    "detail": "Verification Successfull",
    "response_code": "00",
    "nin_data": {
        "firstname": "Test",
        "surname": "Test",
        "middlename": "Test",
        "birthdate": "01-10-1990",
        "userid": "PAQBBA-0016",
        "gender": "M",
        "telephoneno": "08012345616",
        "vnin": "AD123456789114D8",
        "self_origin_lga": "",
        "heigth": "",
        "birthstate": "Lagos",
        "signature": "",
        "religion": "",
        "educationallevel": "",
        "maritalstatus": "",
        "self_origin_state": "",
        "spoken_language": "",
        "trackingId": "",
        "self_origin_place": "",
        "residence_town": "",
        "nok_town": "",
        "residence_state": "Lagos State",
        "residence_address": "Address 1",
        "birthcountry": "",
        "psurname": "",
        "pfirstname": "",
        "nok_lga": "yaba",
        "nok_address2": "",
        "nok_state": "Lagos State",
        "nok_surname": "Test",
        "nok_firstname": "test",
        "ospokenlang": "",
        "residencestatus": "Active",
        "pmiddlename": "",
        "email": "test@test.com",
        "nok_postalcode": "",
        "nin": "",
        "employmentstatus": "Unemployed",
        "birthlga": "yaba",
        "residence_lga": "yaba",
        "title": "Mr",
        "profession": "",
        "centralID": "",
        "nok_address1": "test address 1",
        "photo": "/9j/4AAQSkZJRgABAQAAAQABAAD/4gxsdW1pAAADlaAAFklFQyBodHRwOi8vd3d3...
        "nok_middlename": ""
    },
    "verification": {
        "status": "VERIFIED",
        "reference": "5f24365e-38d7-464c-b68b-e4df4f9c5d47"
    }
  }

BVN Verification

Verify Bank Verification Number

POST

https://api.quickverify.com.ng/verification/bvn

Request Header

Key	Description
x-api-key	Your API Key

Request Body

Key	Description
bvn	Bank Verification Number to be verified

Example Request (curl)

 
  curl --location --request POST 'https://api.quickverify.com.ng/verification/bvn' \
  --header 'x-api-key: xxxxxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "bvn":"12345678901"
  }'

Example Response

 
  {
	"status": true,
	"detail": "Verification Successful",
	"response_code": "00",
	"data": {
		"title": "Mr",
		"gender": "Male",
		"maritalStatus": "Single",
		"watchListed": "YES",
		"levelOfAccount": "Level 1 Account",
		"bvn": "54651333604",
		"firstName": "TEST",
		"middleName": "test",
		"lastName": "test",
		"dateOfBirth": "1999-12-21",
		"phoneNumber1": "09082838483",
		"phoneNumber2": "08028323323",
		"registrationDate": "2005-12-21",
		"enrollmentBank": "034",
		"enrollmentBranch": "YABA, Lagos",
		"email": "testt@test.com",
		"lgaOfOrigin": "yaba",
		"lgaOfResidence": "yaba",
		"nin": "12345567895",
		"nameOnCard": "test test",
		"nationality": "Nigeria",
		"residentialAddress": "yaba",
		"stateOfOrigin": "Lagos",
		"stateOfResidence": "Lagos",
		"base64Image": "/9j/4AAQSkZJRgABAQAAAQABAAD/4gxYSUNDX1BST0ZJTEUL2FBMegIiiVoE+ZQo...
	},
	"verification": {
		"status": "VERIFIED",
		"reference": "73876307-7f13-4f0c-ab31-2569e3e4c524"
	}
  }

CAC Verification

Verify CAC information and get a more detailed responser

POST

https://api.quickverify.com.ng/verification/cac

Request Header

Key	Description
x-api-key	Your API Key

Request Body

Key	Description
rc_number	The Registration number of the company
company_type	BN or RC or IT

Example Request (curl)

 
  curl --location --request POST 'https://api.quickverify.com.ng/verification/cac' \
  --header 'x-api-key: xxxxxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "rc_number":"092932",
    "company_type":"RC"
  }'

Example Response

 
  {
	"status": true,
	"detail": "Verification Successfull",
	"response_code": "00",
	"data": {
		"rc_number": "092932",
		"company_name": "TEST COMPANY",
		"state": "DELTA State",
		"company_address": "10 lekki phase 12, Ousn state",
		"company_status": "Active",
		"city": "Akure",
		"branchAddress": "lekki phase 10, Osun state",
		"lga": "Birnin Kudu",
		"registrationDate": "1986-06-04T00:00:00Z",
		"directors": [
			{
				"surname": "Test",
				"firstname": "Test",
				"otherName": "",
				"email": "test@test.com",
				"phoneNumber": "080000000000",
				"gender": "Male",
				"formerNationality": "",
				"city": "Lagos",
				"occupation": "Trader",
				"formerName": "",
				"corporationName": "",
				"rcNumber": "092932",
				"state": "Lagos",
				"accreditationnumber": "00000000000",
				"formType": "National Identification Number",
				"numSharesAlloted": "",
				"typeOfShares": "",
				"dateOfBirth": "",
				"dateOfAppointment": "",
				"status": "ACTIVE",
				"formerSurname": "",
				"formerFirstName": "",
				"formerOtherName": "",
				"identityNumber": "",
				"otherDirectorshipDetails": "",
				"affiliateTypeFk": {
					"name": "",
					"description": ""
				},
				"countryFk": {
					"name": "",
					"code": ""
				},
				"lga": "",
				"isCorporate": false,
				"nationality": "Nigerian",
				"address": "Test address",
				"streetNumber": "Test Street",
				"isChairman": "Yes",
				"isDesignated": "",
				"postcode": "",
				"formerNameType": "",
				"affiliatesResidentialAddress": {
					"country": "NIGERIA",
					"state": "",
					"lga": "",
					"city": "",
					"address": "",
					"streetNumber": "",
					"postcode": "",
					"hideResidentialAddress": false,
					"affiliateType": ""
				},
				"affiliatesPscInformation": "",
				"isPublicUser": ""
			}
		],
		"searchScore": "0",
		"email_address": "test@test.com",
		"company_type": "RC"
	},
	"verification": {
		"status": "VERIFIED",
		"reference": "ae4d4b11-d8eb-47c9-ba4a-469118973adc"
	}
  }

NIN By Tracking Id

Verify NIN information using Tracking id

POST

https://api.quickverify.com.ng/verification/ninbytrackingid

Request Header

Key	Description
x-api-key	Your API Key

Request Body

Key	Description
tid	Tracking ID

Example Request (curl)

 
  curl --location --request POST 'https://api.quickverify.com.ng/verification/ninbytrackingid' \
--header 'x-api-key: 2AKlXZnXFRYmmphoFLVqyZNxYRWbsXqh' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tid":"S1Y1NYFBP111B11"
}'

Example Response

 
  {
    "success": true,
    "message": "Verification Successfull",
    "data": {
        "nin": "11111111111",
        "firstname": "Test Name",
        "middlename": "Test Middlename",
        "lastname": "Test Lastname",
        "gender": "m",
        "address": "Test Address",
        "face": "/9j/4AAQSkZJRgABAgAAAQABAAD/b3+Pn6/9wpO9fl9aQYPIp3S..."
        "town": "Test Town",
        "state": "Test State",
        "message": "",
        "trackingid": "S1Y1NYFBP111B11",
        "status": "1",
        "surname": "JAFAR",
        "trackingId": "S1Y1NYFBP111B11",
        "tracking_id": "S1Y1NYFBP111B11",
        "residence_Town": "Test Town",
        "residence_lga": "",
        "residence_state": "Test state",
        "residence_AdressLine1": "Test Address",
        "photo": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkS...",
        "image": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkS..."
    }
}

Instant IPE

Instant IPE Submission

POST

https://api.quickverify.com.ng/verification/instantipe

Request Header

Key	Description
x-api-key	Your API Key

Request Body

Key	Description
tid	Tracking ID

Example Request (curl)

 
  curl --location --request POST 'https://api.quickverify.com.ng/verification/instantipe' \
  --header 'x-api-key: xxxxxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "tid":"xxxxxxxxxx"
  }'

Example Response

{}

Instant IPE Status

Get status of already submitted Instant IPE

POST

https://api.quickverify.com.ng/verification/instantipestatus

Request Header

Key	Description
x-api-key	Your API Key

Request Body

Key	Description
tid	Tracking ID

Example Request (curl)

 
  curl --location --request POST 'https://api.quickverify.com.ng/verification/instantipestatus' \
  --header 'x-api-key: xxxxxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "tid":"xxxxxxxxxx"
  }'

Example Response

{}

Instant Validation

Instant Validation Submission

POST

https://api.quickverify.com.ng/verification/instantvalidation

Request Header

Key	Description
x-api-key	Your API Key

Request Body

Key	Description
nin	National Identity Number
scode	Service code (47=No Record,48=Sim Card Issues,49=Bank Validation or 50=Photographer error)

Example Request (curl)

 
  curl --location --request POST 'https://api.quickverify.com.ng/verification/instantvalidation' \
  --header 'x-api-key: xxxxxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "nin":"xxxxxxxxxxx",
    "scode":"49"
  }'

Example Response

{}

Instant Validation Status

Get status of already submitted validation

POST

https://api.quickverify.com.ng/verification/instantvalidationstatus

Request Header

Key	Description
x-api-key	Your API Key

Request Body

Key	Description
nin	National Identity Number

Example Request (curl)

 
  curl --location --request POST 'https://api.quickverify.com.ng/verification/instantvalidationstatus' \
  --header 'x-api-key: xxxxxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "nin":"xxxxxxxxxxx"
  }'

Example Response

{}