Saltar para o conteúdo principal
PUT
curl

Autorizações

x-api-key
string
header
obrigatório

A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está incorreta, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys.

Corpo

application/json

Todos os campos são opcionais; o PUT aplica uma atualização parcial.

is_enabled
boolean
Maximum string length: 255
lei
string
Maximum string length: 20
jurisdiction
string
Maximum string length: 8
name_matching_strictness
enum<string>

CONTAINS aceita um nome cujas palavras aparecem todas no outro.

Opções disponíveis:
NONE,
STRICT,
CONTAINS,
DEFAULT,
FUZZY
confirmation_timeout_hours
integer
Intervalo necessário: x >= 1
timeout_outcome
enum<string>
Opções disponíveis:
HOLD,
REJECT,
PROCEED
compliance_email
string<email>

E-mail de contacto de conformidade para o seu perfil de VASP. A rede Didit lista o seu perfil apenas após este endereço ser confirmado através de uma ligação enviada por e-mail (POST /v3/travel-rule/settings/compliance-email/confirmation/); a sua alteração requer uma nova confirmação.

is_discoverable
boolean

Se o seu perfil de VASP pode ser listado na rede Didit: encontrado em GET /v3/travel-rule/vasps/ por outros clientes Didit e contactado na via INTERNAL. A listagem também requer uma aplicação de produção, o Travel Rule ativo, uma denominação social e um e-mail de conformidade confirmado; didit_network indica quais estão em falta. O valor predefinido é true.

threshold_amount
string

String decimal, zero ou superior, na moeda predefinida da sua aplicação. Montante mínimo de transferência que aciona um câmbio gerido.

ownership_validation_mode
enum<string>

Consulte o campo da resposta com o mesmo nome.

Opções disponíveis:
FULL,
SIMPLIFIED,
AUTOMATED
simplified_validation_threshold
string

String decimal, 0 ou superior.

data_sharing_fields
object

Fundido por tipo de entidade: um tipo de entidade que omitir mantém a sua escolha atual. Uma escolha que não consiga cumprir as obrigações de ordenante do regime da sua jurisdiction (TFR da UE ou Recomendação 16 da FATF), incluindo uma lista vazia, é recusada com 400.

matching_rules
object

Fundido por tipo de entidade e por campo dentro do mesmo. Um campo que esse tipo de entidade não compare (por exemplo, date_of_birth para company) é recusado com 400.

inbound_auto_accept
boolean
allow_self_declaration
boolean
allow_screenshot_proof
boolean

Quando for true, o widget de propriedade da carteira disponibiliza o carregamento de capturas de ecrã como método de prova de propriedade. O padrão é true.

auto_wallet_verification
boolean
vasp_attribution_enabled
boolean
counterparty_screening_enabled
boolean

Triagem opcional de sanções e notícias adversas de VASPs de contraparte, faturada por triagem ao preço da Triagem AML da empresa. Quando ativada, a Didit analisa a contraparte que uma exchange de saída alcança (reutilizando uma triagem com menos de 30 dias) e pode analisar uma com POST /v3/travel-rule/vasps/{vasp_id}/screening/. Predefinição false: nada é analisado ou faturado.

sunrise_policy
enum<string>

HOLD, REJECT, PROCEED ou vazio para seguir timeout_outcome. Consulte o campo de resposta com o mesmo nome.

Opções disponíveis:
,
HOLD,
REJECT,
PROCEED
non_responsive_policy
enum<string>

HOLD, REJECT, PROCEED ou vazio para seguir timeout_outcome. Consulte o campo de resposta com o mesmo nome.

Opções disponíveis:
,
HOLD,
REJECT,
PROCEED
disabled_networks
enum<string>[]

Redes que optaram por não aderir à plataforma. Não desativa as suas adesões próprias associadas nem disponibiliza redes indisponíveis.

Opções disponíveis:
GTR,
TRUST,
VERIFYVASP,
SYGNA

Resposta

Definições e perfil atualizados, na mesma estrutura do GET.

is_enabled
boolean

Indica se o fluxo de negociação gerida de Travel Rule está ativo para transações de saída travelRule nesta aplicação.

jurisdiction
string

O código de jurisdição operacional do seu VASP. Predefinição "EU". A Didit mapeia-o para o regime que estampa nas suas transações de Travel Rule como travel_rule_regime (por exemplo, EU ou o código de um Estado-membro da UE passa a eu), que as regras de transação podem utilizar como chave. Outros clientes da Didit veem-no como a sua jurisdição no diretório de VASPs assim que a rede Didit listar o seu perfil.

Maximum string length: 8
name_matching_strictness
enum<string>

Com que rigor os nomes dos beneficiários têm de coincidir antes de uma transferência poder atingir o estado COMPLETED. CONTAINS aceita um nome cujas palavras apareçam todas no outro.

Opções disponíveis:
NONE,
STRICT,
CONTAINS,
DEFAULT,
FUZZY
confirmation_timeout_hours
integer

Horas que uma transferência AWAITING_COUNTERPARTY pode permanecer por confirmar antes de o processo periódico de limpeza a expirar. Predefinição: 48.

Intervalo necessário: x >= 1
timeout_outcome
enum<string>

O que acontece à transação subjacente quando uma transferência expira. Predefinição HOLD. sunrise_policy e non_responsive_policy têm precedência quando se aplicam e estão definidas.

Opções disponíveis:
HOLD,
REJECT,
PROCEED
threshold_amount
string

String decimal, na moeda predefinida da sua aplicação. Montante mínimo de transferência que aciona uma partilha gerida; transferências abaixo dele resolvem diretamente para NOT_APPLICABLE. A Didit compara o montante da transação convertido para a sua moeda predefinida, ou o amount_in_default_currency enviado; quando nenhum montante convertido estiver disponível, o limiar não se aplica. O valor predefinido é "0.00" (o TFR da UE não aplica montante mínimo).

ownership_validation_mode
enum<string>

Quanto comprovativo é necessário para comprovar a propriedade de uma carteira. FULL exige sempre um comprovativo (mensagem assinada, depósito de teste ou captura de ecrã revista), nunca a palavra do utilizador final. SIMPLIFIED aceita uma autodeclaração abaixo de simplified_validation_threshold e um comprovativo acima dele. AUTOMATED permite que o livro de endereços e comprovativos anteriores respondam por si próprios, incluindo autodeclarações enquanto allow_self_declaration for verdadeiro. Predefinição: AUTOMATED.

Opções disponíveis:
FULL,
SIMPLIFIED,
AUTOMATED
simplified_validation_threshold
string

String decimal, por predefinição "0.00". No modo SIMPLIFIED, uma transferência abaixo deste montante (na moeda do limiar) aceita uma autodeclaração. Uma transferência sem montante nessa moeda conta como estando acima dele.

data_sharing_fields
object

Os campos que a Didit envia para o VASP contraparte sobre os seus próprios utilizadores, por tipo de entidade. O name e o wallet_address são sempre enviados, independentemente do que a lista indicar. Um tipo de entidade que nunca escolheu partilha todos os campos. Uma lista vazia também é uma escolha: partilha apenas o nome e a carteira.

matching_rules
object

Com que rigor cada campo dos dados da contraparte é comparado com o que possui, por tipo de entidade. Um campo omitido mantém a sua predefinição. NONE ignora a comparação, STRICT exige exatamente as mesmas palavras, CONTAINS aceita um valor cujas palavras apareçam todas no outro, DEFAULT é a correspondência de subconjunto padrão e FUZZY aceita grafias aproximadas (e, para datas de nascimento, dia e mês trocados).

A denominação social do seu VASP. Obrigatória (não vazia) para definir is_enabled como true.

lei
string

O seu Identificador de Entidade Jurídica (LEI), apresentado no diretório de VASP.

compliance_email
string<email>

E-mail de contacto de conformidade para o seu perfil de VASP. A rede Didit lista o seu perfil apenas após este endereço ser confirmado através de uma ligação enviada por e-mail (POST /v3/travel-rule/settings/compliance-email/confirmation/); a sua alteração requer uma nova confirmação.

is_discoverable
boolean

Se o seu perfil de VASP pode ser listado na rede Didit: encontrado em GET /v3/travel-rule/vasps/ por outros clientes Didit e contactado na via INTERNAL. A listagem também requer uma aplicação de produção, o Travel Rule ativo, uma denominação social e um e-mail de conformidade confirmado; didit_network indica quais estão em falta. O valor predefinido é true.

inbound_auto_accept
boolean

Quando for true, um inquérito TRP de entrada cuja carteira do beneficiário seja uma entrada verificada no livro de endereços com um nome correspondente é aprovado automaticamente. Quando for false, esse inquérito aguarda em ON_HOLD que o aprove ou recuse com o endpoint de propriedade. As transferências pela via INTERNAL e após depósito não são afetadas. O padrão é true.

allow_self_declaration
boolean

Quando for true, o widget de propriedade da carteira disponibiliza a autodeclaração como método de prova alternativo. O valor predefinido é true.

allow_screenshot_proof
boolean

Quando for true, o widget de propriedade da carteira disponibiliza o carregamento de capturas de ecrã como método de prova de propriedade. O padrão é true.

auto_wallet_verification
boolean

Quando for true, a submissão de uma transferência da Travel Rule de saída que necessite de comprovativo de controlo da carteira por parte do utilizador final gera automaticamente uma sessão do widget de propriedade da carteira vinculada à transação e expõe-na no bloco action_required da transação. O padrão é true.

vasp_attribution_enabled
boolean

Quando for true, uma transferência da Travel Rule de saída que nenhuma via consiga encaminhar é atribuída através de análise de blockchain: a carteira de destino é associada ao respetivo VASP proprietário, a entidade é registada na transferência e no diretório de VASP, e as vias são executadas novamente uma vez com o nome atribuído. O padrão é true.

counterparty_screening_enabled
boolean

Triagem opcional de sanções e notícias adversas de VASPs de contraparte, faturada por triagem ao preço da Triagem AML da empresa. Quando ativada, a Didit analisa a contraparte que uma exchange de saída alcança (reutilizando uma triagem com menos de 30 dias) e pode analisar uma com POST /v3/travel-rule/vasps/{vasp_id}/screening/. Predefinição false: nada é analisado ou faturado.

sunrise_policy
enum<string>

O impacto que uma transferência expirada tem na sua transação quando a contraparte é uma entrada do diretório numa jurisdição em sunrise_jurisdictions, que ainda não aplica a Travel Rule: HOLD move-a para análise, REJECT recusa-a, PROCEED mantém o seu estado inalterado. Vazio (a predefinição) segue timeout_outcome. Aplica-se antes de non_responsive_policy.

Opções disponíveis:
,
HOLD,
REJECT,
PROCEED
sunrise_jurisdictions
string[]
read-only

Apenas de leitura. Os países (ISO 3166 alfa-2) que a Didit trata como estando num período de transição da Travel Rule, onde sunrise_policy se aplica. Atualmente CO, KH e VN. Qualquer outra jurisdição, bem como uma vazia ou desconhecida, segue timeout_outcome.

non_responsive_policy
enum<string>

O impacto que uma transferência expirada tem na sua transação quando a contraparte é uma entrada do diretório cuja capacidade de resposta é UNRESPONSIVE: HOLD, REJECT ou PROCEED, tal como em timeout_outcome. Vazio (a predefinição) segue timeout_outcome. sunrise_policy aplica-se primeiro quando ambas forem aplicáveis.

Opções disponíveis:
,
HOLD,
REJECT,
PROCEED
travel_address
string

Apenas de leitura. O Travel Address próprio do seu VASP - o endpoint codificado de consulta TRP de entrada que outros VASP utilizam para entrar em contacto consigo. Vazio enquanto is_enabled for false.

disabled_networks
enum<string>[]

Redes que optaram por não aderir à plataforma. Não desativa as suas adesões próprias associadas nem disponibiliza redes indisponíveis.

Opções disponíveis:
GTR,
TRUST,
VERIFYVASP,
SYGNA
networks
object
read-only

Por rede, como esta aplicação enviaria e por que motivo não o consegue fazer. Nenhuma rede, incluindo a GTR, está incluída por predefinição: uma rede fica acessível através da sua própria adesão ligada, ou através da adesão da Didit assim que a adesão da Didit a essa rede estiver ativa e o seu próprio participante nela estiver ativo. Não se trata de uma verificação de estado ou de entrega em tempo real.

didit_network
object
read-only

Indica se a rede Didit lista o seu perfil de VASP, para que outros clientes Didit o encontrem no diretório e o contactem pela via INTERNAL, bem como cada condição que ainda falta cumprir.

Última modificação em 7 de novembro de 2026