Address Verification Services Structure 📇

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

Request Structure

Request Attribute	Format	Status	Description
searchParameter	String	Mandatory	The address verification number you wish to validate would be passed in this field.
firstName	String	May be mandatory or optional depending on the service
lastName	String	Mandatory
dob	dd-mm-yyy	May be mandatory or optional depending on the service
phone	String	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
transactionReference	String	Optional
kycType	String	Mandatory
street	String	Mandatory
lga	String	Mandatory
city	String	May be mandatory or optional depending on the service
state	String	Mandatory
landmark	String	May be mandatory or optional depending on the service

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 in the description.
verificationType	String	The verificationType passed in the request is returned here.
verificationStatus	String	This field lets you know if the address verification was successful. Options are: VERIFIED: This means that the ADDRESS-VERIFICATION is valid. NOT VERIFIED This means that the ADDRESS-VERIFICATION is invalid PENDING This status means that the verification could not be completed. Refer to the responseCode for the specific failure reason.
transactionStatus	String	This indicates the wallet debit status. The options are successful or failed.
transactionReference	String	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	String	Date the transaction was done.
searchParameter	String	The address verification number that was verified.
response	Json	This contains the actual verification data as retrieved from the identity provider. The format of the data varies depending on the service called.