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

Retrieve Account

GET /api/v2/directory/accounts/{reference_id}

This endpoint retrieves the details of a specific account identified by reference_id

Path Parameters

Name
Type
Description
Required

reference_id

string

Account unique identifier.

True

Response

{
  "status": "success",
  "data": {
    "reference_id": "johndoe",
    "account_type": "individual",
    "account_category": "customer",
    "email": "john@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",
      "nationality_country": "SG",
      "residence_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_department": null,
      "address_subdepartment": null,
      "address_postbox": "PO Box 789",
      "address_city_location": "New York",
      "address_city": "New York",
      "address_region": "New York",
      "address_district": "Manhattan",
      "address_postcode": "10001",
      "address_country_code": "US"
    },
    "created": "2024-02-26 21:57:18.000 +0800",
    "last_modified": "2024-02-27 10:37:20.000 +0800"
  }
}

Last updated 1 month ago