Introduction

GraphQL offers flexibility and the ability to define precisely the data you want to fetch. You can learn more about how GraphQL works on our Introduction to GraphQL.

The compliance dashboard GUI is built on top of a GraphQL API. If you want to integrate 21 Travel Rule with your own IT infrastructure, you can use the same GraphQL API.

Interactive Exploration with GraphiQL

The API is self-documenting and can be explored through the GraphiQL application (note the "i" in the name). For basic testing purposes, we host a GraphiQL instance against our testing server. Please note that this is provided on a "best effort" basis with limitations in availability and data persistence. Therefore usage for exploration and basic testing only is advised. Note also that the provided GraphiQL instance may show unreleased API changes that can deviate from your deployed version. For production use, you need to run 21 Travel Rule on your IT infrastructure and use GraphiQL served via the /graphiql endpoint to explore the API that corresponds to your deployed version.

Graphiql Docs

Accessing the Schema Definition Language

In addition to exploring the API through GraphiQL, you can also download the Schema Definition Language. Note that this is not intended for human consumption, but it can be useful when writing clients against the API.