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

List VASPs

GET /api/v2/directory/vasps

This endpoint returns the list of VASP records that can be sorted and paginated.

Query Parameters

Name
Type
Description
Required

page

integer

The page number to view from the list. Defaults to 1 if not provided.

False

size

integer

The size of each page. Defaults to 50 if not provided.

False

sort

string

Sort the list based on the provided field name. e.g. vasp_id (asc order) -vasp_id (desc order)

False

Response

{
  "status": "success",
  "data": {
    "items": [
      {
        "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"
      }
    ], 
    "pagination": {
      "total": 1,
      "size": 50,
      "page": 1
    }
  },
  "message": "null"
}

Last updated 10 days ago