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. Either individual or entity
True
account_category
string
Category of the account. Valid values: customer or 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 and place_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 field.
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 full details. Required if at least one of the following is not provided:
Required if at least one of the following are not provided:
For individual accounts:
date_of_birth and place_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 full details. Required if at least one of the following is not provided:
Required if at least one of the following are not provided:
For individual accounts:
date_of_birth and place_of_birth or
address or
customer_id
For entity accounts:
address or
customer_id
Conditional
Individual Data Type
individual_name
object
Object containing the individual´s name. Includes: name_type, name_first, name_middle, and name_last.
True
individual_localname
object
Localized version of the individual´s name. Includes: name_type, name_first, name_middle, and name_last
False
name_type
string
Type of the name. Required for both individual_name and individual_localname. Example: LEGL
True
name_first
string
First name of the individual. Example: John
False
name_middle
string
Middle name of the individual. Example: Robert
False
name_last
string
Last name of the individual. Example: Doe
True
date_of_birth
date
Date of birth of the account holder. Example: 1990-01-01
Conditional
place_of_birth
string
Place of birth of the account holder. Example: Singapore
Conditional
nationality_country
string
Nationality of the individual (ISO 3166-1 alpha-2 country code). Example: SG
False
residence_country
string
Country of residence (ISO 3166-1 alpha-2 code). Example: US
False
Entity Data Type
entity_name
object
Object that contains the legal and business name of the entity. Includes: name_type, name_legal, and name_business.
True
name_type
string
Type of name. Required in both entity_name and entity_localname. Example: LEGL
True
name_legal
string
Official legal name of the entity. Example: Digital Capital Pte. Ltd.
True
entity_localname
object
Local language version of the entity name. Includes: name_type, name_legal, and name_business.
False
name_business
string
Common or trade name of the business. Example: Digital Capital
False
registration_country
string
Country of incorporation for the business (ISO 3166-1 alpha-2 country code). Example: SG
False
Address Data Type
address_type
string
Type of address. Common value: "GEOG" (Geographic).
Conditional
address_line
string
Full address in a single line. Alternatively, use address_street_no or address_building_name with address_street_name. Example: Apt 123
Conditional
address_street_no
string
Street number. Must be used with address_street_name if address_line is not provided. Example: 456
Conditional
address_street_name
string
Street name. Required if using address_street_no or address_building_name. Example: Elm Street
Conditional
address_building_name
string
Name of the building where the account holder is located. This field can be used as an alternative to address_street_no when combined with address_street_name. Example: Elmwood Apartments, TechHub Tower
Conditional
address_floor
string
Floor number within the building. Example: 15
False
address_room
string
Room number within the building. Example: 1503
False
address_department
string
Department at the address (e.g., billing, compliance).
False
address_subdepartment
string
Sub-department at the address.
False
address_postbox
string
Post office box number. Example: PO Box 789
False
address_city_location
string
Local city location reference. Optional, used in some jurisdictions.
False
address_city
string
City of the address. Example: New York
Conditional
address_region
string
Region, state, or province. Example: New York
False
address_district
string
District of the address. Example: Manhattan
False
address_postcode
string
Postal code. Example: 08012
False
address_country_code
string
ISO 3166-1 alpha-2 country code. Example: US
Conditional
National ID Data Type
national_id_type
string
Type of national identification. For Individual Accounts: ARNU, CCPT, DRLC, FIIN, SOCS, IDCD, MISC ForEntity Accounts: RAID, TXID, LEIX, MISC
Conditional
national_id
string
National identification number assigned to the individual or entity. Example: ABC123456
Conditional
issue_country
string
ISO 3166-1 alpha-2 country code of the country that issued the national identification. Example: US
Conditional
registration_authority
string
Identifier of the national registration authority. Must match an entry in the GLEIF Registration Authorities List.
Conditional
Sample Request
Sample Request
Last updated