Identity
Last updated April 8th, 2024
The identity endpoint has a set of fields that are available to verify the user’s 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.
Response Object
Request
1234567891011121314151617181920
{
"status": "successful",
"message": "Request was succesfully completed",
"timestamp": "2024-05-01T19:12:36.885Z",
"data": {
"full_name": "SAMUEL OLAMIDE NOMO",
"bvn": "22300000965",
"email": "samuel@neem.com",
"phone": "08012345678",
"gender": "male",
"dob": "1997-08-07",
"address_line1": "23 shittu animashaun", //null
"state_of_origin": "Lagos State",
"lga_of_origin": null,
"marital_status": null,
"created_at": "2024-04-30T17:16:01.317Z",
"updated_at": "2024-04-30T17:16:01.317Z"
}
}
Identity Fields
| Field | Description | Type |
| full_name | The full name of a connected customer account. | string |
| The email address of a connected customer account. | string | |
| phone | The phone number of a connected customer account. | string |
| gender | The gender identity of a connected customer account. | string |
| dob | The date of birth of a connected customer account. | string |
| bvn | The Bank verification number of a connected customer account. | string |
| marital_status | The marital status of a connected customer account, whether single, married etc. | string |
| address_line1 | The provided home address of a connected customer account. | string |
| state_of_origin | An alternative home address of a connected customer account. | string |
| lga_of_origin | Local goverment of origing of the connected customer account. | string |