What are Top-Level Keys?
Due to discrepancies of keys returned from our providers, we have filtered and standardised the JSON top-level keys below to simplify the use of our JSON response across all our supported ID types.
Key
Description
Example
Country
Country where ID was issued
"NG"
IDType
The type of ID that was issued
"DRIVERS_LICENSE"
IDNumber
The ID number that was looked up in the ID authority database
"ABC000000000"
SecondaryIDNumber
Another ID number that is tied to another ID type ( different from the ID type been looked up) e.g. SA Passport also has the SA National ID printed on the data page.
"000000000"
ExpirationDate
Expiration date of the ID card (when applicable)
"2021-08-15"
FullName
Full name of ID owner
"Leo Doe Joe"
DOB
Date of birth of ID owner
"2000-09-20"
Photo
Photo of ID owner on file in the ID authority database
Base64 Encoded String
PhoneNumber
Phone number of ID owner
"12345678900"
PhoneNumber2
Second phone number of ID owner (when available)
"Not Available"
Document
Photo of ID card on file in the ID authority database (when applicable)
"Not Available"
Gender
Gender of ID owner
"Male"
Address
Address of ID owner
NOTE: this might not be the current address of the ID owner
"10, Workbox, Ojora Close, Victoria Island, Lagos State"
IDNumberPreviouslyRegistered
Boolean value that informs you if ID info has previously been used successfully to register a user.
Only available on Biometric KYC product.
<true | false>
UserIDsOfPreviousRegistrants
Registered User IDs that have previously used the ID info you just queried.
Only available on Enhanced KYC + SmartSelfie™ product.
["12134","23456"]
Copy link