The result fields shown for each scope are the common ones. Exactly which fields come back depends on the provider configured for your organization, and some are optional. Read the
result object by key.NIN by NIN number
nin looks up a National Identification Number.
string
required
The 11 digit NIN.
firstName, middleName, lastName, gender, dateOfBirth, phoneNumber, stateOfOrigin, lgaOfOrigin, residentialAddress, and a portrait image field.
NIN by phone number
pnv resolves a NIN from a registered phone number, returning the same kind of identity record.
string
required
The phone number registered against the NIN.
Virtual NIN
vnin verifies a Virtual NIN, the tokenized form of a NIN.
string
required
The Virtual NIN token.
BVN
bvn looks up a Bank Verification Number.
string
required
The 11 digit BVN.
firstName, middleName, lastName, gender, dateOfBirth, phoneNumber1, phoneNumber2, email, stateOfOrigin, lgaOfOrigin, stateOfResidence, residentialAddress, nationality, maritalStatus, enrollmentBank, enrollmentBranch, registrationDate, levelOfAccount, watchListed, and a portrait image field.
Permanent Voter’s Card
pvc verifies a Permanent Voter’s Card by its VIN.
string
required
The Voter Identification Number.
Passport
passport verifies a Nigerian passport.
string
required
The passport number.
Bank account
bank_account verifies a bank account and returns the account name.
string
required
The bank, as a bank code or identifier.
string
required
The 10 digit account number.
Premium bank account
premium_bank_account is an enriched bank account check.
string
required
The account number.
string
The bank. Optional for this scope.
Phone number
phone verifies a phone number and returns the identity linked to it.
string
required
The phone number.
A
found or not_found result is charged; a failed result is not. NIN and BVN records include a portrait; where present, it is returned as a link to a securely stored image, not raw bytes in the response. See Wallet and billing.