Skip to content

VASP Directory

Find and identify counterparties through the dashboard directory or Entities API.

The VASP Directory is available in the CryptoSwift Client Dashboard. The same directory is powered by the Entities API, which you can use to build counterparty VASP selection or identification into your own product.

Using the directory is optional. Asking a customer to select a known beneficiary VASP, or resolving a VASP name from your existing data, can improve Travel Rule message delivery and help your team validate the intended counterparty. Directory results describe entities; use KYW when you need to classify a particular wallet.

Search the directory

GET /entities supports free-text search, filters, sorting, and offset pagination. For example, this request searches in-network entities matching “Acme”:

curl --get 'https://api-dev.cryptoswift.eu/entities?q=Acme&_inNetwork=true&_start=0&_end=25&_sort=name&_order=ASC' \
  --header "X-Api-Key: $API_KEY"

Send this request from your backend so the tenant API key is not exposed in browser or mobile code.

Available filters include:

ParameterPurpose
qSearch entity name, legal name, website, and email data.
_inNetworkReturn entities that are or are not connected to the CryptoSwift network.
_isRiskAssessedFilter by availability of an entity risk assessment.
_typeFilter by one or more entity types. Repeat the parameter for multiple values.
_riskSeverityFilter by one or more risk severities. Repeat the parameter for multiple values.
_start, _endSelect an offset range. The default response contains 20 records.
_sort, _orderSort by updatedAt, name, or type in ASC or DESC order.

The response header X-Total-Count contains the number of matching entities. List records can include the canonical id, names, type, network and verification state, countries, website, MiCA and warning-list flags, and a risk assessment with score and severity. Check type and isVerified before presenting a result as a verified VASP.

Resolve a name

Use the lookup endpoint when you already have a counterparty name or alias and want its canonical directory record:

curl --get 'https://api-dev.cryptoswift.eu/entities/lookup?name=Acme%20Exchange' \
  --header "X-Api-Key: $API_KEY"

If the matched record is an alias or duplicate, CryptoSwift returns its linked master entity. A blank name is rejected.

For user-entered counterparty names, search as the user types and keep the selected name. You can also store the entity id with your case if your workflow needs the directory record later. Do not silently pick the first fuzzy result when more than one entity could match.

Use the name in a Travel Rule message

When creating a Travel Rule transaction, pass the selected directory result's name, not its entity ID, to POST /transactions: use vaspInfo.beneficiaryVaspName for an outgoing transaction or vaspInfo.originatorVaspName for an incoming one. These fields accept free text. You can provide any VASP name, including one that does not appear in the directory; CryptoSwift will try to identify it and automatically link a matching entity. Directory selection is helpful, but not required. For an outgoing request example, see Improving Data Quality.

Retrieve a detailed profile

curl --get 'https://api-dev.cryptoswift.eu/entities/{entityId}' \
  --header "X-Api-Key: $API_KEY"

The detail response extends the list record with available contact information, notices, logo and URL data, supported fiat currencies, launch and traffic data, and legal entities. Legal entity records can include entityName, country, companyId, referenceNo, and regulator.

Fields depend on available source data, so integrations should tolerate null, empty, or omitted optional values.

Common integration pattern

  1. Query /entities to populate a searchable counterparty selector.
  2. Keep the selected name for the Travel Rule message; save the entity ID too if your own workflow needs it.
  3. Pass that name in vaspInfo.beneficiaryVaspName or vaspInfo.originatorVaspName when creating the transaction.
  4. Retrieve /entities/{id} only when the workflow needs the expanded legal or risk profile.
  5. Re-query periodically rather than treating directory attributes as permanent.

Next steps