Ospree docs
API ReferenceWebsiteSocials
  • GETTING STARTED
    • Intro to Ospree
      • What is the Travel Rule?
      • Types of Travel Rule transfers
      • What is a wallet address?
      • What is an Account at Ospree?
      • What is a VASP or CASP?
    • Account
      • Understand user roles
      • Add and manage users
      • Change your password
      • Set up two-factor authentication (2FA)
      • Log in with 2FA-enabled
  • DASHBOARD
    • Overview
    • Travel Rule
      • Start a transfer
      • Search and filter transfers
      • Interoperability
      • Self-hosted wallets
    • Accounts Directory
      • Create an account
      • Edit an account
      • Create a recipient
      • Edit a recipient
      • Add a new wallet
      • VASPs
        • Search and filter
        • Request a VASP
  • OSPREE API
    • Overview
    • API integration flows
    • Authentication
    • Breaking Changes
    • Errors
    • Token Identifier
    • Webhooks
      • Webhook events
      • Webhook request
      • Webhook management
    • Travel Rule
      • Create Transfer
      • List Transfers
      • Retrieve Transfer
      • Update Transfer
      • Action Transfer
    • Accounts Directory
      • Create Account
      • List Accounts
      • Retrieve Account
      • Update Account
      • Remove account
      • Search account
      • Retrieve VASP
      • Search VASP
      • List VASPs
    • Blockchain Analytics
      • Create Address
      • List Addresses
      • Retrieve Address
      • Assign an address to account
      • Create Transaction (Beta)
      • List Transactions (Beta)
      • Retrieve Transaction (Beta)
  • Resources and Help
    • Data pre-validation
    • Sunrise Issue
Powered by GitBook
On this page
  1. OSPREE API
  2. Accounts Directory

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

Name
Type
Description
Required

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 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 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 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 the complete list of fields. 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
Name
Type
Description
Required

individual_name

object

Object containing the individual name. Refer to the Name Data Type for the complete list of fields.

True

individual_localname

object

Localized version of the individual´s name. Refer to the Name Data Type for the complete list of fields.

False

date_of_birth

date

Date of birth of the account holder.

Required if at least one of the following are not provided: For individual accounts:

  • customer_id

  • or address

  • or national_id

Example: 1990-01-01

Conditional

place_of_birth

string

Place of birth of the account holder.

Required if at least one of the following are not provided: For individual accounts:

  • customer_id

  • or address

  • or national_id

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

Name Data Type

Name
Type
Description
Required

name_type

string

Type of the name. Required for both individual_name and individual_localname.

Accepted values:

  • 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

Entity Data Type
Name
Type
Description
Required

entity_name

object

Object that contains the legal and business name of the entity.

Refer to the Name Data Type for the complete list of fields.

True

entity_localname

object

Local language version of the entity name.

Refer to the Name Data Type for the complete list of fields.

False

registration_country

string

Country of incorporation for the business (ISO 3166-1 alpha-2 country code).

Example: SG

False

Name Data Type

Name
Type
Description
Required

name_type

string

Type of entity name.

Accepted values:

  • LEGL

True

name_legal

string

Official legal name of the entity.

Example: Digital Capital Pte. Ltd.

True

name_business

string

Common or trade name of the business.

Example: Digital Capital

False

Address Data Type
Name
Type
Description
Required

address_type

string

Type of address. Common value: "GEOG" (Geographic).

True

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

True

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

True

National ID Data Type
Name
Type
Description
Required

national_id_type

string

Type of national identification.

For Individual Accounts:

  • ARNU- Alien registration number

  • CCPT- Passport number

  • DRLC- Driver License number

  • FIIN- Foreign investment identity number

  • SOCS- Social security number

  • IDCD - Identity card number

  • MISC- Unspecified

For Entity Accounts:

  • RAID- Registration authority identifier

  • TXID- Tax identification number

  • LEIX- Legal Entity Identifier

  • MISC- Unspecified

True

national_id

string

National identification number assigned to the individual or entity.

Example: ABC123456

True

issue_country

string

ISO 3166-1 alpha-2 country code of the country that issued the national identification.

This field must NOT be specified if account_type is entity.

Example: US

Conditional

registration_authority

string

Identifier of the national registration authority.

Must match an entry in the GLEIF Registration Authorities List. This field is required if account_type is entity and national_id_type is NOT LEIX.

Conditional

Sample Request

curl -X POST https://sandbox.ospree.io/api/v2/directory/accounts

-h 'Content-Type: application/json' \
-h 'Accept: application/json' \
-h 'Authorization: ••••••' \
-d '{
  "reference_id": "80MBoQkMNS",
  "account_type": "entity",
  "account_category": "customer",
  "email": "you@company.com",
  "customer_id": "80MBoQkMNS",
​
  "entity": {
    "registration_country": "SG",
    "entity_name": {
      "name_type": "LEGL",
      "name_legal": "Digital Capital",
      "name_business": "Digital Capital Pte. Ltd."
    },
    "entity_localname": {
      "name_type": "LEGL",
      "name_legal": "Digital Capital",
      "name_business": "Digital Capital Pte. Ltd."
    }
​
  },
  "address": {
    "address_type": "GEOG",
    "address_line": "Apt 123",
    "address_street_no": "456",
    "address_street_name": "Elm Street",
    "address_building_name": "Elmwood Apartments",
    "address_floor": "15",
    "address_room": "1503",
    "address_postbox": "PO Box 789",
    "address_city": "New York",
    "address_region": "New York",
    "address_district": "Manhattan",
    "address_postcode": "10001",
    "address_country_code": "US"
  },

  "national_id": {
    "national_id_type": "RAID",
    "national_id": "3523524",
    "registration_authority": "RA999999"
  }
}' 
{
    "status": "success",
    "data": {
        "reference_id": "80MBoQkMNS",
        "account_type": "entity",
        "account_category": "customer",
        "email": "you@company.com",
        "customer_id": "80MBoQkMNS",
        "entity": {
            "entity_name": {
                "name_type": "LEGL",
                "name_legal": "Digital Capital",
                "name_business": "Digital Capital Pte. Ltd."
            },
            "entity_localname": {
                "name_type": "LEGL",
                "name_legal": "Digital Capital",
                "name_business": "Digital Capital Pte. Ltd."
            },
            "registration_country": "SG"
        },
        "address": {
            "address_type": "GEOG",
            "address_line": "Apt 123",
            "address_street_no": "456",
            "address_street_name": "Elm Street",
            "address_building_name": "Elmwood Apartments",
            "address_floor": "15",
            "address_room": "1503",
            "address_postbox": "PO Box 789",
            "address_city": "New York",
            "address_region": "New York",
            "address_district": "Manhattan",
            "address_postcode": "10001",
            "address_country_code": "US"
        },
        "national_id": {
            "national_id_type": "RAID",
            "national_id": "3523524",
            "registration_authority": "RA999999"
        },
        "created": "2025-04-14T23:29:38+00:00",
        "last_modified": "2025-04-14T23:29:38+00:00"
    }
}

Sample Request

curl -X POST https://sandbox.ospree.io/api/v2/directory/accounts

-h 'Content-Type: application/json' \
-h 'Accept: application/json' \
-h 'Authorization: ••••••' \
-d '{
  "reference_id": "qJu7298S4D",
  "account_type": "individual",
  "account_category": "non-customer",
  "email": "you@company.com",
  "customer_id": "qJu7298S4D",

  "individual": {
    "date_of_birth": "1988-06-27",
    "place_of_birth": "Singapore",
    "nationality_country": "SG",
    "residence_country": "US",
    "individual_name": {
      "name_type": "LEGL",
      "name_first": "John",
      "name_middle": "Mark",
      "name_last": "Doe"
    },
    "individual_localname": {
      "name_type": "LEGL",
      "name_first": "John",
      "name_middle": "Mark",
      "name_last": "Doe"
    }

  },
  "address": {
    "address_type": "GEOG",
    "address_line": "Apt 123",
    "address_street_no": "456",
    "address_street_name": "Elm Street",
    "address_building_name": "Elmwood Apartments",
    "address_floor": "15",
    "address_room": "1503",
    "address_postbox": "PO Box 789",
    "address_city": "New York",
    "address_region": "New York",
    "address_district": "Manhattan",
    "address_postcode": "10001",
    "address_country_code": "US"
  }
}' 
{
    "status": "success",
    "data": {
        "reference_id": "qJu7298S4D",
        "account_type": "individual",
        "account_category": "non-customer",
        "email": "you@company.com",
        "individual": {
            "individual_name": {
                "name_type": "LEGL",
                "name_first": "John",
                "name_middle": "Mark",
                "name_last": "Doe"
            },
            "individual_localname": {
                "name_type": "LEGL",
                "name_first": "John",
                "name_middle": "Mark",
                "name_last": "Doe"
            },
            "date_of_birth": "1988-06-27",
            "place_of_birth": "Singapore, Singapore"
        },
        "address": {
            "address_type": "GEOG",
            "address_line": "Apt 123",
            "address_street_no": "456",
            "address_street_name": "Elm Street",
            "address_building_name": "Elmwood Apartments",
            "address_floor": "15",
            "address_room": "1503",
            "address_postbox": "PO Box 789",
            "address_city": "New York",
            "address_region": "New York",
            "address_district": "Manhattan",
            "address_postcode": "10001",
            "address_country_code": "US"
        },
        "created": "2025-04-14T13:18:31+00:00",
        "last_modified": "2025-04-14T13:18:31+00:00"
    }
}

Last updated 19 days ago