The Account Model
The Accounts Resource allows you to create and manage the accounts under your business account.
Sample Account Object
{
"data":{
"account_id":"a5732d28468746d1b4d20d73a6ed2ffb",
"account_number":27624209,
"first_name":"James",
"last_name":"Bond",
"email":"james@bond.com",
"risk_appetite":0,
"is_proprietary":false,
"account_status":"ACTIVE",
"verification_status":"UNVERIFIED",
"is_verified":false,
"account_type":"Individual",
"phone_number":null,
"date_of_birth":null,
"gender":null,
"identifications":[
],
"banks":[
],
"address":{
"street":"",
"lga":"",
"area_code":"",
"city":"",
"state":""
},
"next_of_kin":{
"first_name":"",
"last_name":"",
"email":"",
"phone_number":"",
"relationship":"",
"gender":null
},
"date_joined":"2021-11-30T13:01:39.734110+00:00"
},
"errors":null,
"message":"Request successful",
"status":"success"
}
Attributes
account_idstring |
Account Unique Identifier |
account_numbernumber |
Generated Account Number. |
first_namestring |
First Name of Account |
last_namestring |
Last Name of Account |
string |
Account Email |
risk_appetitenumber |
Risk Appetite associated with Account |
is_proprietarystring |
True or False Value to check if an account is proprietary |
account_statusstring |
Displays if an account is Active or Not |
verification_statusstring |
Displays the current Verification Status of Account |
is_verifiedstring |
True or False value for Account Verification |
account_typestring |
Displays the account type associated with the account |
phone_numberstring |
Phone number of Account |
date_of_birthstring |
Date of Birth associated with Account |
genderstring |
Gender associated with an account |
identificationsstring |
KYC information of the Account |
bankslist |
List of user's banks |
addressobject |
Address information of the Account |
next_of_kinstring |
Next of Kin Data of the Account |
date_joinedstring |
Account Creation Date |