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: johndoe
True
account_type
string
Type of the account. Either individual or entity
True
account_category
string
Category of the account. Either customer or recipient.
Defaults to customer when not specified
False
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 is 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 is entity
address
object
The object that contains the fields specific for the address of the account.
Refer to the Address Data Type for the complete list of fields.
Required if date_of_birth and place_of_birth or national_id is not provided.
national_id
object
The object that contains the fields specific for the national ID of the account.
Refer to the National ID Data Type for the complete list of fields.
Required if date_of_birth and place_of_birth or address is not provided.
Individual Data Type
individual_name
object
Object that contains the individual name fields: name_type, name_first, name_middle, and name_last
True
individual_localname
object
Local name of the individual.
Contains the individual local name fields: name_type, name_first, name_middle, and name_last
False
name_type
string
Type of the name. Required for individual_name and individual_local_name.
Example: LEGL
True
name_first
string
First name of the account holder.
Example: John
False
name_middle
string
Middle name of the account holder.
Example: Robert
False
name_last
string
Last name of the account holder.
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: Sinagpore
Conditional
nationality_country
string
ISO 3166-1 alpha-2 country code of the nationality of the account holder.
Example: SG
False
residence_country
string
ISO 3166-1 alpha-2 country code of the place of residence of the account holder.
Example: US
False
Entity Data Type
entity_name
object
The object that contains the entity name fields: name_type, name_legal, and name_business
True
entity_localname
object
The local name of the entity.
Contains the entity local name fields: name_type, name_legal, and name_business
False
name_type
string
Type of the entity name. Required for entity_name and entity_localname.
Example: LEGL
True
name_legal
string
Legal name of the business.
Example: Digital Capital Pte. Ltd.
True
name_business
string
Common name of the business.
Example: Digital Capita
False
registration_country
string
ISO 3166-1 alpha-2 country code of incorporation for the business.
Example: SG
False
Address Data Type
address_type
string
Type of the address.
Example: GEOG
True
address_line
string
Either providing an address_line or including a combination of address_street_no or address_building_name along with address_street_name is required.
Example: Apt 123
Conditional
address_street_no
string
Either providing an address_line or including a combination of address_street_no or address_building_name along with address_street_name is required.
Example: 456
Conditional
address_street_name
string
Either providing an address_line or including a combination of address_street_no or address_building_name along with address_street_name is required.
Example: Elm Street
Conditional
address_building_name
string
Either providing an address_line or including a combination of address_street_no or address_building_name along with address_street is required.
Example: Elmwood Apartments
Conditional
address_floor
string
Floor number in the building.
Example: 15
False
address_room
string
Room number in the building.
Example: 1503
False
address_department
string
Department within the address.
False
address_subdepartment
string
Sub-department within the address.
False
address_postbox
string
Post office box number.
Example: PO Box 789
False
address_city_location
string
Geographical location of the city.
False
address_city
string
City of the account holder's address.
Example: New York
True
address_region
string
Region or state of the account holder's address.
Example: New York
False
address_district
string
District of the account holder's address.
Example: Manhattan
False
address_postcode
string
Postal code of the account holder's address.
Example: 08012
False
address_country_code
string
ISO 3166-1 alpha-2 country code of the account holder's address.
Example: US
True
National ID Data Type
national_id_type
string
Type of national identification.
For Individual Accounts:
ARNU,
CCPT,
DRLC,
FIIN,
SOCS,
IDCD,
and MISC
For Entity Accounts:
RAID,
TXID,
LEIX,
and MISC
True
national_id
string
National identification number.
Example: ABC123456
True
issue_country
string
ISO 3166-1 alpha-2 country code of the country that issued the national identification.
Example: US
True
registration_authority
string
Must be present in the GLEIF Registration Authorities List.
Required if account_type is entity and national ID type is not LEIX.
Conditional
Response
Sample Request Body
Last updated