Skip to main content
PUT
curl
Didit’s Travel Rule settings API updates the VASP profile, licence and exchange configuration you supply. Update the licence Send licence as a string of up to 255 characters. Omit it to leave the current reference unchanged, or send "" to clear it. The settings response includes the saved licence.

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 wrong, revoked or expired; 403 means no key was sent, 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

All fields optional; PUT applies a partial update.

is_enabled
boolean
Maximum string length: 255
lei
string
Maximum string length: 20
jurisdiction
string
Maximum string length: 8
vasp_jurisdiction
string

Your VASP profile's own jurisdiction, up to 3 characters (for example GB or USA), shown to other Didit customers in the VASP directory. Independent of jurisdiction, which sets the regulatory regime Didit stamps on your transfers. Send an empty string to clear it; the directory then shows jurisdiction.

Maximum string length: 3
name_matching_strictness
enum<string>

CONTAINS accepts one name whose words all appear in the other.

Available options:
NONE,
STRICT,
CONTAINS,
DEFAULT,
FUZZY
confirmation_timeout_hours
integer
Required range: x >= 1
timeout_outcome
enum<string>
Available options:
HOLD,
REJECT,
PROCEED
compliance_email
string<email>

Compliance contact email for your VASP profile. The Didit network lists your profile only once this address is confirmed through an emailed link (POST /v3/travel-rule/settings/compliance-email/confirmation/); changing it needs a new confirmation.

is_discoverable
boolean

Whether your VASP profile can be listed in the Didit network: found in GET /v3/travel-rule/vasps/ by other Didit customers and reached on the INTERNAL rail. Listing also needs a live application, Travel Rule on, a legal name and a confirmed compliance email; didit_network says which are missing. Default true.

threshold_amount
string

Decimal string, zero or greater, in your application's default currency. Minimum transfer amount that triggers a managed exchange.

ownership_validation_mode
enum<string>

See the response field of the same name.

Available options:
FULL,
SIMPLIFIED,
AUTOMATED
simplified_validation_threshold
string

Decimal string, 0 or more.

data_sharing_fields
object

Merged per entity type: an entity type you leave out keeps its current choice. A choice that cannot meet the originator obligations of your jurisdiction regime (EU TFR or FATF Recommendation 16), an empty list included, is refused with 400.

matching_rules
object

Merged per entity type, and per field inside it. A field that entity type does not compare (for example date_of_birth for company) is refused with 400.

inbound_auto_accept
boolean
allow_self_declaration
boolean
allow_screenshot_proof
boolean

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

auto_wallet_verification
boolean
vasp_attribution_enabled
boolean
counterparty_screening_enabled
boolean

Opt-in sanctions and adverse-media screening of counterparty VASPs, billed per screening at the Company AML Screening price. When on, Didit screens the counterparty an outbound exchange reaches (reusing a screening younger than 30 days) and you can screen one with POST /v3/travel-rule/vasps/{vasp_id}/screening/. Default false: nothing is screened or billed.

sunrise_policy
enum<string>

HOLD, REJECT, PROCEED, or empty to follow timeout_outcome. See the response field of the same name.

Available options:
,
HOLD,
REJECT,
PROCEED
non_responsive_policy
enum<string>

HOLD, REJECT, PROCEED, or empty to follow timeout_outcome. See the response field of the same name.

Available options:
,
HOLD,
REJECT,
PROCEED
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
licence
string

VASP licence or registration reference. Empty when not supplied.

Maximum string length: 255
Example:

"REG-EXAMPLE"

Response

Updated settings and profile, in the same shape as GET.

is_enabled
boolean

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

jurisdiction
string

Your VASP's regulatory regime code. Default "EU". Didit maps it to the regime it stamps on your Travel Rule transactions as travel_rule_regime (for example EU or an EU member code becomes eu), which transaction rules can key on, and it decides which data fields the exchange must share. Other Didit customers see vasp_jurisdiction in the VASP directory; while vasp_jurisdiction is empty, the directory shows this value instead.

Maximum string length: 8
vasp_jurisdiction
string

Your VASP profile's own jurisdiction, up to 3 characters (for example GB or USA), shown to other Didit customers in the VASP directory. It is independent of jurisdiction, the regulatory regime Didit stamps on your transfers; while vasp_jurisdiction is empty, the directory shows jurisdiction. Empty until you set it.

name_matching_strictness
enum<string>

How strictly beneficiary names must match before a transfer can reach COMPLETED. CONTAINS accepts one name whose words all appear in the other.

Available options:
NONE,
STRICT,
CONTAINS,
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. sunrise_policy and non_responsive_policy take precedence when they apply and are set.

Available options:
HOLD,
REJECT,
PROCEED
threshold_amount
string

Decimal string, in your application's default currency. Minimum transfer amount that triggers a managed exchange; transfers below it resolve straight to NOT_APPLICABLE. Didit compares the transaction amount converted to your default currency, or the amount_in_default_currency you send; when no converted amount is available, the threshold does not apply. Defaults to "0.00" (EU TFR applies no minimum amount).

ownership_validation_mode
enum<string>

How much proof a wallet's ownership takes. FULL always needs a proof (signed message, test deposit or reviewed screenshot), never the end user's word. SIMPLIFIED accepts a self-declaration below simplified_validation_threshold and a proof above it. AUTOMATED lets the address book and earlier proofs answer on their own, self-declarations included while allow_self_declaration is true. Default AUTOMATED.

Available options:
FULL,
SIMPLIFIED,
AUTOMATED
simplified_validation_threshold
string

Decimal string, default "0.00". In SIMPLIFIED mode a transfer below this amount (in the threshold currency) accepts a self-declaration. A transfer with no amount in that currency counts as above it.

data_sharing_fields
object

The fields Didit sends to the counterparty VASP about your own users, per entity type. The name and the wallet_address are always sent, whatever the list says. An entity type you never chose shares every field. An empty list is a choice too: it shares the name and the wallet only.

matching_rules
object

How strictly each field of the counterparty's data is compared with what you hold, per entity type. A field you leave out keeps its default. NONE skips the comparison, STRICT needs exactly the same words, CONTAINS accepts one value whose words all appear in the other, DEFAULT is the standard subset match, and FUZZY accepts close spellings (and, for dates of birth, a swapped day and month).

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. The Didit network lists your profile only once this address is confirmed through an emailed link (POST /v3/travel-rule/settings/compliance-email/confirmation/); changing it needs a new confirmation.

is_discoverable
boolean

Whether your VASP profile can be listed in the Didit network: found in GET /v3/travel-rule/vasps/ by other Didit customers and reached on the INTERNAL rail. Listing also needs a live application, Travel Rule on, a legal name and a confirmed compliance email; didit_network says which are missing. Default true.

inbound_auto_accept
boolean

When true, an inbound TRP inquiry whose beneficiary wallet is a verified address-book entry with a matching name is approved automatically. When false, that inquiry waits in ON_HOLD for you to approve or deny it with the ownership endpoint. INTERNAL-rail and after-deposit transfers are not affected. Default true.

allow_self_declaration
boolean

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

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.

counterparty_screening_enabled
boolean

Opt-in sanctions and adverse-media screening of counterparty VASPs, billed per screening at the Company AML Screening price. When on, Didit screens the counterparty an outbound exchange reaches (reusing a screening younger than 30 days) and you can screen one with POST /v3/travel-rule/vasps/{vasp_id}/screening/. Default false: nothing is screened or billed.

sunrise_policy
enum<string>

What an expired transfer does to its transaction when the counterparty is a directory entry in a jurisdiction on sunrise_jurisdictions, which does not enforce the Travel Rule yet: HOLD moves it to review, REJECT declines it, PROCEED leaves its status untouched. Empty (the default) follows timeout_outcome. Applies before non_responsive_policy.

Available options:
,
HOLD,
REJECT,
PROCEED
sunrise_jurisdictions
string[]
read-only

Read-only. The countries (ISO 3166 alpha-2) Didit treats as in a Travel Rule sunrise period, where sunrise_policy applies. Currently CO, KH and VN. Any other jurisdiction, and an empty or unknown one, follows timeout_outcome.

non_responsive_policy
enum<string>

What an expired transfer does to its transaction when the counterparty is a directory entry whose responsiveness is UNRESPONSIVE: HOLD, REJECT or PROCEED, as for timeout_outcome. Empty (the default) follows timeout_outcome. sunrise_policy applies first when both fit.

Available options:
,
HOLD,
REJECT,
PROCEED
travel_address
string

Read-only. Your VASP's own travel address - the encoded inbound TRP inquiry endpoint other VASPs use to reach you. Empty while is_enabled is false.

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

Per network, how this application would send and why it cannot. No network, including GTR, is included by default: a network is reachable through your own connected membership, or through Didit's membership once Didit's membership of that network is live and your own participant on it is active. Not a live health or delivery check.

didit_network
object
read-only

Whether the Didit network lists your VASP profile, so other Didit customers find it in the directory and reach it on the INTERNAL rail, and each condition it still misses.

licence
string

VASP licence or registration reference. Empty when not supplied.

Maximum string length: 255
Example:

"REG-EXAMPLE"

Last modified on November 11, 2026