Examples

NOTE: that the provided example queries showcase only a tiny fraction of our API. Please use the GraphiQL API Browser to discover the full API and its documentation and derive GraphQL therefrom.

Example Queries

As the name suggests and as is the rule with GraphQL, use the operation type 'query' to return objects from the backend. There are examples for several objects available:

  • autod: autod is the internal API that provides unified access to all databases and services of 21 Travel Rule. Its GraphQL API is used by the Web User Interface and custom integrated services from the VASP.

  • trpd: trpd is the processing engine for exchanging Travel Rule data through Travel Rule Protocol (TRP). It's possible to run multiple instances of trpd for HA, failover and zero-downtime updates.

  • aopd: aopd is the processing engine for registering ownership proofs through Address Ownership Proof Protocol (AOPP; Digital Signatures), Visual Proof or Satoshi Tests. It handles communication with self-hosted (non-custodial) wallets. It's possible to run multiple instances of aopd for HA, failover and zero-downtime updates.

  • email: email is a fallback mechanism for outgoing transactions to other VASPs. It connects to your SMTP server.

Example Mutations

As the name suggests and as is the rule with GraphQL, the operation type 'mutation' can be used to affect changes in the backend. Notice that the object type mutation is explicit in the examples. GraphQL allows omitting the query type but not the mutation type. There would be no way to distinguish them otherwise.

Similarly to queries, there are examples for several objects available:

  • trpd: trpd is the processing engine for exchanging Travel Rule data through Travel Rule Protocol (TRP). It's possible to run multiple instances of trpd for HA, failover and zero-downtime updates.

  • aopd: aopd is the processing engine for registering ownership proofs through Address Ownership Proof Protocol (AOPP; Digital Signatures), Visual Proofs and Satoshi Tests. It handles communication with self-hosted (non-custodial) wallets. It's possible to run multiple instances of aopd for HA, failover and zero-downtime updates.

  • email: email is a fallback mechanism for outgoing transactions to other VASPs. It connects to your SMTP server.

Example Subscriptions

The operation type 'subscriptions' is used to get pushed updates from the server when certain data changes. GraphQL allows omitting the query type but not the subscription type. There would be no way to distinguish them otherwise.

The GraphQL subscriptions are exposed using the GraphQL over Websocket Protocol.

A GraphQL over Websocket Protocol client implementation for Node.js can be found here.

There are currently two subscriptions available:

Authentication for Subscriptions

Please note the dedicated subscription chapter on the authentication page.