Skip to main content
GET
curl

Network availability

GTR, TRUST, VerifyVASP, and Sygna all require an active membership. GTR is not automatically included with Didit. Read networks for the application you are configuring:
  • own - Your connected membership takes precedence, even if the network is in disabled_networks. Exchanges use your network identity.
  • didit - Platform membership is configured and you have not disabled it. No customer membership credentials are needed for this network.
  • off - You disabled platform routing and have no connected own membership. Remove the network from disabled_networks to allow platform routing when available, or connect your own membership.
  • unavailable - Neither a connected own membership nor an enabled platform membership is available. Connect your own membership in Marketplace, or use a reachable INTERNAL, TRP, or EMAIL counterparty.
platform_available is configuration status, not a live network health check. connected reports a saved membership that passed local credential validation, not a successful exchange with the provider. Enabling is_enabled or clearing disabled_networks cannot provision a missing membership. For checks you can run without network credentials, see Testing without network credentials.

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Response

200 - application/json

Current Travel Rule settings and VASP profile.

is_enabled
boolean

Whether the managed Travel Rule negotiation flow is active for outbound travelRule transactions on this application.

jurisdiction
string

Your VASP's operating jurisdiction code. Default "EU".

Maximum string length: 8
name_matching_strictness
enum<string>

How strictly beneficiary names must match before a transfer can reach COMPLETED.

Available options:
NONE,
STRICT,
DEFAULT,
FUZZY
confirmation_timeout_hours
integer

Hours an AWAITING_COUNTERPARTY transfer may remain unconfirmed before the periodic sweeper expires it. Default 48.

Required range: x >= 1
timeout_outcome
enum<string>

What happens to the underlying transaction when a transfer expires. Default HOLD.

Available options:
HOLD,
REJECT,
PROCEED
threshold_amount
string

Decimal string. Minimum transfer amount that triggers a managed exchange; transfers below it resolve straight to NOT_APPLICABLE. Defaults to "0.00" (EU TFR applies no minimum amount).

Your VASP's legal name. Required (non-blank) to set is_enabled to true.

lei
string

Your Legal Entity Identifier, surfaced in the VASP directory.

compliance_email
string<email>

Compliance contact email for your VASP profile.

is_discoverable
boolean

Whether your VASP profile appears in GET /v3/travel-rule/vasps/ search results and can be reached on the INTERNAL rail. Default true.

inbound_auto_accept
boolean

When true, inbound transfers whose beneficiary wallet is a verified address-book entry with a matching name are accepted automatically, without a manual review step. Default false.

allow_self_declaration
boolean

When true, the wallet-ownership widget offers self-declaration as a fallback proof method. Default false.

allow_screenshot_proof
boolean

When true, the wallet-ownership widget offers screenshot upload as an ownership evidence method. Default true.

auto_wallet_verification
boolean

When true, submitting an outbound Travel Rule transfer that needs end-user proof of wallet control auto-mints a wallet-ownership widget session bound to the transaction and exposes it in the transaction's action_required block. Default true.

vasp_attribution_enabled
boolean

When true, an outbound Travel Rule transfer that no rail can route is attributed through blockchain analytics: the destination wallet is resolved to its owning VASP, the entity is recorded on the transfer and in the VASP directory, and the rails are re-run once with the attributed name. Default true.

travel_address
string

Read-only. Your VASP's own travel address - the encoded inbound TRP inquiry endpoint other VASPs use to reach you. Populated once your VASP profile is complete.

disabled_networks
enum<string>[]

Networks opted out of platform membership. Does not disable your connected own memberships or provision unavailable networks.

Available options:
GTR,
TRUST,
VERIFYVASP,
SYGNA
networks
object
read-only

Effective membership configuration for each network. No network, including GTR, is included by default. This is not a live health or delivery check.