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.
Country where ID was issued
The type of ID that was issued
The ID number that was looked up in the ID authority database
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.
Expiration date of the ID card (when applicable)
Full name of ID owner
"Leo Doe Joe"
Date of birth of ID owner
Photo of ID owner on file in the ID authority database
Phone number of ID owner
Second phone number of ID owner (when available)
Photo of ID card on file in the ID authority database (when applicable)
Gender of ID owner
Address of ID owner
NOTE: this might not be the current address of the ID owner
"10, Workbox, Ojora Close, Victoria Island, Lagos State"
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>
Registered User IDs that have previously used the ID info you just queried.
Only available on Enhanced KYC + SmartSelfie™ product.