Skip to main content
POST
curl

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.

Body

application/json
vasp_id
string<uuid>
required

The directory entry this workspace is. Read ids from GET /v3/travel-rule/vasps/.

Response

The workspace with its claim status.

The free Travel Rule workspace of an application that joined free.

joined_free
boolean
work_email
string<email>
joined_at
string<date-time> | null
claim
object
prefill
object

Profile values taken from the directory entry: vasp_id, legal_name, lei, jurisdiction, compliance_email, domains. Nothing is written until the claim is made.

domain
object
billing_enabled
boolean

Receiving Travel Rule data is free. Sending is billed only after billing is enabled.

billing_enabled_at
string<date-time> | null
didit_network
object

Whether the Didit network lists this VASP and, when not, each condition it still misses.

settings
object