JSON Top-Level Keys

An easy way to interact with our API

Due to discrepancies of keys returned from our providers, we have filtered and standardized the JSON top-level keys below to simplify the use of our JSON response across all our supported ID types.

Sample JSON Response

},
"Country": "NG",
"IDType": "BVN",
"IDNumber": "00000000000",
"ExpirationDate": "Not Available",
"FullName": "Doe Joe Leo",
"DOB": "2000-01-20",
"Photo": "/9j/4AAQSkZJRgABAgAAAQABAAD/
"PhoneNumber": "12345678900",
"Gender": "Male",
"Address": "10, Workbox, Ojora Close, Victoria Island, Lagos State",
.
.
.
"FullData": {
"BVN": "00000000000",
"FirstName": "Doe",
"MiddleName": "Joe",
"LastName": "Leo",
"DateOfBirth": "20-January-2000",
"PhoneNumber1": "12345678900",
"Gender": "Male",
"enrollmentBank": "000",
"enrollmentBranch": "...",
"email": "...",
"lgaOfOrigin": "....",
"lgaOfResidence": "Victoria Island",
"maritalStatus": "Single",
"nin": "00000000000",
"nameOnCard": "Doe Joe Leo",
"nationality": "Nigeria",
"residentialAddress": "10, Workbox, Ojora Close, Victoria Island,Lagos State",
"stateOfOrigin": "LagosState",
"stateOfResidence": "Lagos State",
"title": "",
"watchListed": "NO",
"LevelOfAccount": "Level 2 - Medium Level Accounts",
"registrationDate": "",
"ImageBase64": "/9j/4AAQSkZJRgABAgAAAQABAAD/
}

Also, the table below summaries the breakdown of the top-level keys that are consistently returned by our supported ID types (e.g. NIN, BVN, SSNIT etc) across all coverage services. This will guide and ensure you interact with the JSON data appropriately.

Nigeria ID data availability

IDType/Key Returned

IDNumber

Full Name

Photo

Gender

DOB

Phone Number

Address

Expiration Date

NIN

BVN

PASSPORT

VOTER’S ID

DRIVER’S LICENSE

NATIONAL ID

BANK ACCOUNT

TIN

CAC

Ghana ID data availability

IDType/Key Returned

IDNumber

Full Name

Photo

DOB

Gender

Expiration Date

Address

Phone Number

SSNIT

VOTER’S ID

DRIVER’S LICENSE

PASSPORT

Kenya ID data availability

IDType/Key Returned

IDNumber

Full Name

DOB

Photo

Gender

Expiration Date

Phone Number

Address

NATIONAL ID

ALIEN CARD

PASSPORT