Identity Services Structure 🪪

All our identity services share a common request and response structure as detailed below.

Request Structure

Request AttributeFormatMandatory StatusDescription
searchParameterStringMandatoryThe identity number you wish to validate would be passed in this field. It could be NIN, BVN, driver's license number, etc, depending on the identity service you're calling
firstNameStringMay be mandatory or optional depending on the service
lastNameStringMay be mandatory or optional depending on the service
phoneStringMay be mandatory or optional depending on the service
genderStringMay be mandatory or optional depending on the service
dobyyyy-mm-ddMay be mandatory or optional depending on the service
verificationTypeStringAlways mandatory.Every service has its specific verification type. Ensure to pass in the right verification type for the right service. You may view a list of verification types here
biometricStringString (Base64)Mandatory for identity face or finger match services
fingerPositioninteger (1 - 10)Mandatory for identity finger match services.

Response Structure

Response AttributeFormatDescription
responseCodeString'00' indicates success. Full list of response codes can be found here
descriptionStringIf the transaction failed or an error was encountered, details of the error can be found here
verificationTypeStringThe verificationType passed in the request is returned here
verificationStatusStringThis field lets you know if the identity verification was successful. Options are:

VERIFIED: This means that the BVN is valid.
NOT VERIFIED This means that the BVN is invalid
PENDING This status means that the verification could not be completed. Refer to the responseCode for the specific failure reason
transactionStatusThis indicates the wallet debit status. The options are successful or failed.
transactionReferenceIf you supplied a transactionReference, the same will be returned here. Else, we would generate a reference and return that to you in this field.
transactionDateDate the transaction was done
searchParameterThe identity number that was verified
responseThis contains the actual identity data as retrieved from the identity provider. The format of the data varies depending on the service called