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

Accounts Directory

Last updated 2 months ago

Directory Module Overview

The Directory module streamlines operations by simplifying account and VASP data management. It supports account creation, deletion, and updates to keep information current and allows for VASP data queries. Preemptive account creation is possible before engaging other modules. The module also handles the creation or modification of account associations, which enhances integration with analytics, travel rule transfers, and reporting modules. It complies with the IVMS101 standard, ensuring universal communication between VASPs and compatibility with leading Travel Rule

  • POST /api/v2/directory/accounts

  • GET /api/v2/directory/accounts

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

  • PATCH /api/v2/directory/accounts/{reference_id}

  • DELETE /api/v2/directory/accounts/{reference_id}

  • GET /api/v2/directory/accounts/search

  • GET /api/v2/directory/vasps/{vasp_id}

  • GET /api/v2/directory/vasps/search

Create account
List account
Get account details
Modify account
Remove account
Search account
Retrieve VASP
Lookup VASP