The identity endpoint has a set of fields that are available to verify the user identity and also helps your business for KYC (Know Your Customer) and user verification purposes. This can also be used for auto-completing account data and helps in reducing fraud. Personal information such as name, phone number, date of birth, or Bank Verification Number (BVN) can be returned to help identify the user from a specific financial institution.

API Object

{
    "fullName":"HASSAN ABDULHAMID TOMIWA",
    "email": "[email protected]",
    "phone" :"08180411245",
    "gender": "male",
    "dob": "02-09-1990",
    "bvn": "00469311245",
    "maritalStatus”: null,
    "addressLine1”: “23 shittu animashaun”,
    "addressLine2”: “Gbagada”
}

Identity Fields

Field description type
fullName The full name of a connected customer. string
email The email address of a connected customer. string
phone The phone number of a connected customer. string
gender The gender identity of a connected customer. string
dob The date of birth of a connected customer. string
bvn The Bank verification number of a connected customer. string
maritalStatus The marital status of a connected customer whether single, married etc. string
addressLine1 The provided home address of a connected customer. string
addressLine2 An alternative home address of a connected customer. string

Did this page help you?