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

Search account

GET /api/v2/directory/accounts/search

This endpoint facilitates the search of an account using various lookup values, such as business and legal name representations, or first name and last name representations, or the email. If the provided lookup value does not match any account record, the endpoint will return no results.

Query Parameters

Name
Type
Description
Required

search_term

string

The parameter 'search_term' is used to search for either, business_name or legal_name, first_name or last_name, or email.

True

account_category

string

The category of the account. Either customer or recipient. When category is not specified, all categories are searched.

account_type

string

The type of the account. Either individual or entity. When type is not specified, all types are searched.

Response

{
    "status": "success",
    "data": [
        {
            "reference_id": "account0001",
            "account_type": "Individual",
            "name": "Devin Booker",
            "account_category": "recipient",
            "email": "devin@example.com",
            "created": "2024-03-19T10:56:56+00:00",
            "last_modified": "2024-05-02T13:00:30+00:00"
        },
        {
            "reference_id": "account0002",
            "account_type": "Entity",
            "name": "Crypto Legal",
            "account_category": "customer",
            "email": "crypto.legal@example.com",
            "created": "2024-09-05T13:58:19+00:00",
            "last_modified": "2024-09-05T13:58:19+00:00"
        },
        {
            "reference_id": "account0003",
            "account_type": "Individual",
            "name": "Clovis Mraz",
            "account_category": "customer",
            "email": "clovis@example.com",
            "created": "2024-05-03T05:04:00+00:00",
            "last_modified": "2024-05-03T05:04:00+00:00"
        }
    ]
}

Last updated 1 month ago