Create Account
POST
/api/v2/directory/accounts
This endpoint is used to create a new account within the directory module. It can create 'individual' or 'entity' accounts.
Body
reference_id
string
Unique identifier for the account.
Example: 245352FA
True
account_type
string
Type of the account.
Accepted Values:
individual
entity
True
account_category
string
Category of the account.
Accepted values:
customer
non-customer
.
Defaults to customer
when not specified.
False
customer_id
string
Internal identifier of the account. Required if at least one of the following is not provided: For individual accounts:
date_of_birth
andplace_of_birth
or
address
or
national_id
For entity accounts:
address
or
national_id
Conditional
email
string
Email address associated with the account.
Example: you@company.com
False
individual
object
The object that contains the fields specific for an individual account.
Refer to the Individual Data Type
for the complete list of fields.
Required if account_type
= individual
entity
object
The object that contains the fields specific for an entity account.
Refer to the Entity Data Type
for the complete list of fields.
Required if account_type
= entity
address
object
Object describing the address of the account.
Refer to the Address Data Type
for the complete list of fields.
Required if at least one of the following are not provided:
For individual accounts:
date_of_birth
andplace_of_birth
or
customer_id
or
national_id
For entity accounts:
customer_id
or
national_id
Conditional
national_id
object
Object containing national ID details.
Refer to the National ID Data Type
for the complete list of fields.
Required if at least one of the following are not provided:
For individual accounts:
date_of_birth
andplace_of_birth
or
address
or
customer_id
For entity accounts:
address
or
customer_id
Conditional
Sample Request
Sample Request
Last updated