Identity

---

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

Response

{
    "fullName": "JOHN DOE",
    "email": "johndoe@gmail.com",
    "phone": "07010000333",
    "gender": "male",
    "dob": "null",
    "bvn": "2242",
    "maritalStatus": "null",
    "address": "null"
}

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
address	The provided home address of a connected customer.	string