Identity Services Structure 🪪

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

Request Structure

Request Attribute	Format	Mandatory Status	Description
transactionReference	String	Optional
searchParameter	String	Mandatory	The 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
firstName	String	May be mandatory or optional depending on the service
lastName	String	May be mandatory or optional depending on the service
phone	String	May be mandatory or optional depending on the service
gender	String	May be mandatory or optional depending on the service
dob	yyyy-mm-dd	May be mandatory or optional depending on the service
verificationType	String	Always 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
biometricString	String (Base64)	Mandatory for identity face or finger match services
fingerPosition	integer (1 - 10)	Mandatory for identity finger match services.

Response Structure

Response Attribute	Format	Description
responseCode	String	'00' indicates success. Full list of response codes can be found here
description	String	If the transaction failed or an error was encountered, details of the error can be found here
verificationType	String	The verificationType passed in the request is returned here
verificationStatus	String	This 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
transactionStatus		This indicates the wallet debit status. The options are successful or failed.
transactionReference		If you supplied a transactionReference, the same will be returned here. Else, we would generate a reference and return that to you in this field.
transactionDate		Date the transaction was done
searchParameter		The identity number that was verified
response		This contains the actual identity data as retrieved from the identity provider. The format of the data varies depending on the service called