Getting Started
Automate Travel Rule messaging and self-hosted wallet proofs using the same GraphQL API that powers the Compliance Dashboard. Connect it to your custody system, customer workflows, and compliance processes.
Start Here
- Get access. Use your deployed instance or request sandbox access to evaluate the API.
- Explore the schema. Open
/graphiqlon your instance and follow the GraphiQL walkthrough to browse the schema and run a query. If GraphQL is new to you, read the introduction to GraphQL first. - Authenticate your client. Follow the authentication guide to obtain an access token for HTTP requests. Authenticate WebSocket subscriptions as well. For Enterprise deployments, assign the required client roles.
- Implement your workflow. Choose an integration workflow below. For self-hosted wallets, follow the proof portal integration workflow.
Integration Workflows
Your integration can support several workflows. For VASP-to-VASP messaging, configure your VASP before implementing the relevant workflow.
| I want to… | Guide |
|---|---|
| Send Travel Rule data for a withdrawal | Outgoing transactions |
| Receive Travel Rule data for a deposit | Incoming transactions |
| Collect self-hosted wallet ownership proofs | Ownership proof portals |
| Enable risk scores for compliance workflows | Risk score providers |
VASP-to-VASP messaging exchanges originator and beneficiary data with another VASP. Self-hosted wallet verification collects evidence from your customer. For each transfer, use the workflow that matches who controls the other wallet. Your custody system remains responsible for executing transfers and crediting deposits. See the transaction lifecycle for the decisions and states your integration needs to handle.
To help identify who controls the other wallet, ask your customer to declare
whether it is self-hosted or held with a VASP, or use a blockchain analytics
provider to identify the entity associated with the wallet address. You can also
use the trustd.lookupBulletinBoard query to look up the address and asset on
TRUST. A successful lookup implies that the counterparty is not a self-hosted
wallet but a VASP. See the GraphQL schema for arguments and
return types.
Configure Your VASP
Set up the protocols you will use before sending or receiving VASP-to-VASP messages:
- TRP: configure your VASP and complete counterparty due diligence.
- TRUST: complete TRUST onboarding, including membership, certificates, bulletin board registration, and instance configuration.
- Email: configure email and add email counterparties for transfers where TRP or TRUST cannot be used. The email flow explains when to request confirmation and how to follow up.
Find Your Task
| I want to… | Start here |
|---|---|
| Understand queries, mutations, and subscriptions | GraphQL basics |
| Browse the schema and try a query | GraphiQL walkthrough |
| Build a client or adapt an example | Integration client SDK |
| Generate client types from the schema | Schema Definition Language |
| Query collections | Filtering and sorting |
| Set up TRP, TRUST, or email | Configure your VASP |
Interactive Exploration with GraphiQL
The API is self-documenting: GraphiQL lets you browse available operations,
their arguments, and return types. Use the /graphiql endpoint on your own
instance for the schema that matches your deployed version.
Integration Client SDK
Use the integration client SDK to handle authentication for HTTP requests and WebSocket subscriptions in your application. It implements a subset of the GraphQL API; use the schema to find operations beyond that subset.
Writing Your Integrated Application
The rules engine example shows an application built with the SDK.
Writing Your Own GraphQL Integration Client
For another language or stack, use the SDK's client implementation as a reference for authentication and subscription handling.
Accessing the Schema Definition Language
Download the GraphQL schema for client tooling and type generation. Use GraphiQL to check it against the schema served by your deployed version of 21 Travel Rule.