Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

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

  1. Get access. Use your deployed instance or request sandbox access to evaluate the API.
  2. Explore the schema. Open /graphiql on 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.
  3. 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.
  4. 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 withdrawalOutgoing transactions
Receive Travel Rule data for a depositIncoming transactions
Collect self-hosted wallet ownership proofsOwnership proof portals
Enable risk scores for compliance workflowsRisk 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:

Find Your Task

I want to…Start here
Understand queries, mutations, and subscriptionsGraphQL basics
Browse the schema and try a queryGraphiQL walkthrough
Build a client or adapt an exampleIntegration client SDK
Generate client types from the schemaSchema Definition Language
Query collectionsFiltering and sorting
Set up TRP, TRUST, or emailConfigure 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.