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 VASP

GET /api/v2/directory/vasps/search

This endpoint facilitates the retrieval of a VASP record using various lookup values, such as business and legal name representations. If the provided lookup value does not match any VASP record, the endpoint will return no results.

Query Parameters

Name
Type
Description
Required

search_term

string

The parameter 'search_term' specifies the VASP (Virtual Asset Service Provider) name that the user wishes to search for in the lookup API endpoint. Example: ARCHAX

True

Response

{
  "status": "success",
  "data": [
    {
      "vasp_id": "ABCXYZ",
      "name_legal": "Sample Ltd",
      "name_business": "Sample Ltdp",
      "address_country_code": "UK",
      "address_street_no": "32",
      "address_street_name": "Old Jewry",
      "address_city": "London",
      "address_region": "South-east England",
      "address_postcode": "EC2R 2DN",
      "website": "www.sample.io",
      "summary": "This firm is registered for certain cryptoasset activities. For more information, check out [ ]",
      "supported_protocols": [
        "flow"
      ],
      "national_id_type_code": "LEIX",
      "national_id": "3523524",
      "national_id_issue_country": null,
      "national_id_registration_authority": "RA999999"
    }
  ],
  "message": "null"
}

Last updated 19 days ago