> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter definições da Travel Rule: perfil VASP da API

> Consulte a configuração da Travel Rule da sua aplicação na Didit: perfil VASP, política de negociação, métodos de prova, modos de rede e a sua Travel Address.



Prompt da API para obter as definições da Travel Rule
        Copiar o prompt para a área de transferência



      
      

\<pre>

\`Read the application's Travel Rule configuration and VASP profile.

Endpoint:
GET https://verification.didit.me/v3/travel-rule/settings/

Authentication:
Use the x-api-key header with my Didit API key.

What to read from the response:
\- is_enabled - whether the managed exchange runs for outbound travelRule transactions.
\- legal_name, lei, jurisdiction, compliance_email, is_discoverable - the VASP profile shown to counterparties and the directory.
\- name_matching_strictness (NONE | STRICT | DEFAULT | FUZZY), confirmation_timeout_hours, timeout_outcome (HOLD | REJECT | PROCEED), threshold_amount, inbound_auto_accept - the negotiation policy.
\- threshold_amount is compared with the amount converted to the application's default currency (or the amount_in_default_currency you send); a transfer whose amount cannot be converted stays in scope, and "0.00" puts every transfer in scope.
Sandbox applications never convert the amount, so there the threshold applies only when the request sends amount_in_default_currency.
\- inbound_auto_accept defaults to true.
\- allow_self_declaration, allow_screenshot_proof, auto_wallet_verification, vasp_attribution_enabled - proof-method and automation toggles (all default to true).
\- counterparty_screening_enabled - opt-in sanctions and adverse-media screening of counterparty VASPs, billed per screening at the Company AML Screening price (default false: nothing is screened or billed).
\- sunrise_policy, non_responsive_policy - HOLD | REJECT | PROCEED, or empty to follow timeout_outcome: what an expired transfer does to its transaction when the counterparty is a directory entry in a jurisdiction listed in sunrise_jurisdictions, or a directory entry whose responsiveness is UNRESPONSIVE.
The sunrise policy applies first, then the non-responsive policy, then timeout_outcome.
\- sunrise_jurisdictions - read-only; the countries Didit treats as in a Travel Rule sunrise period (currently CO, KH and VN).
Any other jurisdiction follows timeout_outcome.
\- disabled_networks - network rails (GTR | TRUST | VERIFYVASP | SYGNA) opted out of Didit's platform membership.
It only affects platform membership, which Didit does not offer on any network yet.
\- Didit has no platform membership on any network today (Didit is onboarding as a provider), so a network rail routes only through your own membership connected in Marketplace.
Enabling Travel Rule does not change network availability.
\- networks - read-only per-network status keyed by gtr/trust/verifyvasp/sygna: {rail, mode, state, reason, platform_available, connected, participant} where mode is own | didit | off | unavailable.
Production does not report didit yet: every network reads unavailable (state didit_onboarding) unless you connected your own membership (own) or disabled it (off).
GET /v3/travel-rule/networks/ returns the same states with the questionnaire and participants.
\- With your own membership, Didit reads the counterparty's answer over GTR, VerifyVASP and Sygna from the network's response or by polling it every 5 minutes. TRUST only sends: a transfer sent over it stays AWAITING_COUNTERPARTY until it expires (then timeout_outcome applies).
If the message cannot be delivered, the transfer moves to COUNTERPARTY_VASP_NOT_REACHABLE instead.
\- travel_address - read-only; your VASP's own encoded TRP inquiry address, for example "ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeS5uNDp3dGW3bweBWLKws442chRsyNxmmJnyWc7frxjjSeABVsYR11UuBePkw6E".
It is empty until Travel Rule is enabled (is_enabled: true).
Share it with counterparties so they can reach you machine-to-machine.
\- didit_network - read-only {listed, missing[], compliance_email_confirmed}: whether the Didit network lists your profile, so other Didit customers find it and reach you on the INTERNAL rail, and each condition still unmet (travel_rule_off, sandbox_application, not_discoverable, legal_name_missing, compliance_email_missing, compliance_email_unconfirmed, excluded_by_staff, internal_organization).
Confirm the compliance email with POST /v3/travel-rule/settings/compliance-email/confirmation/.

Update with PUT /v3/travel-rule/settings/ (partial update - send only the fields to change).

Full guide: /transaction-monitoring/travel-rule#setup.`

\</pre>



      
      

Colar em

## Disponibilidade da redeGTR, TRUST, VerifyVASP e Sygna exigem uma adesão ativa.
A Didit não tem atualmente uma adesão à plataforma em nenhuma destas redes; a Didit está a aderir como prestador.
Até lá, um canal de rede só encaminha através da sua própria adesão, ligada em **Marketplace**.
Consulte `networks` para a aplicação que está a configurar:- **`own`** - A sua adesão ligada tem prioridade, mesmo que a rede esteja em `disabled_networks`. As trocas de mensagens usam a sua identidade na rede.
- **`didit`** - A adesão da Didit representa a sua aplicação como participante ativo nesta rede, com o código que a rede lhe atribuiu.
  Não são necessárias credenciais de adesão de cliente para esta rede.
  Para chegar a este modo é preciso o questionário de rede da Didit e um pedido à rede: consulte [Obter redes Travel Rule](https://docs.didit.me/pt/management-api/travel-rule/get-networks.md).
  A produção ainda não indica este modo, porque a adesão própria da Didit ainda não está ativa.
- **`off`** - Desativou o encaminhamento pela plataforma e não tem nenhuma adesão própria ligada. Remova a rede de `disabled_networks` para permitir o encaminhamento pela plataforma quando estiver disponível, ou ligue a sua própria adesão.
- **`unavailable`** - Nada pode enviar nesta rede para a sua aplicação, por enquanto.
  `state` e `reason` indicam o motivo: por exemplo, `didit_onboarding` enquanto a adesão própria da Didit a esta rede não estiver ativa, ou `questionnaire_needed` antes de o questionário ser aprovado.
  Hoje, todas as redes apresentam este modo, exceto se tiver ligado a sua própria adesão ou desativado a rede.
  Ligue a sua própria adesão em **Marketplace**, ou use uma contraparte acessível de tipo `INTERNAL`, `TRP` ou `EMAIL`.`disabled_networks` afeta apenas a adesão da plataforma da Didit, que ainda não está disponível, por isso não tem efeito no encaminhamento neste momento.Um canal de rede é escolhido quando o `beneficiary_data` da transferência contém o identificador da contraparte nessa rede (por exemplo, `counterparty_gtr_vasp_code` ou `counterparty_trust_membership_id`), ou quando a [entrada no diretório](https://docs.didit.me/pt/transaction-monitoring/travel-rule.md#rotas) da contraparte a associa a um código nessa rede.Nas redes GTR, VerifyVASP e Sygna, a Didit lê a resposta da contraparte na resposta da rede ou consultando a rede a cada 5 minutos, e a transferência passa para `COMPLETED`, `COUNTERPARTY_MISMATCHED_DATA` ou `COUNTERPARTY_VASP_GENERAL_DECLINE`.
Na TRUST, a rede apenas envia: uma transferência enviada por esta rede mantém-se em `AWAITING_COUNTERPARTY` até decorrer o período definido por `confirmation_timeout_hours` e passar a `EXPIRED`, e então aplica-se `timeout_outcome`.
Se a mensagem não puder ser entregue, a transferência passa para `COUNTERPARTY_VASP_NOT_REACHABLE`.
Consulte [Redes Travel Rule](https://docs.didit.me/pt/transaction-monitoring/travel-rule-networks.md) para ver o que cada rede alcança atualmente.`platform_available` é um estado de configuração, não uma verificação do estado da rede em tempo real. `connected` indica uma adesão guardada que passou na validação local das credenciais, e não uma troca bem-sucedida com o prestador. Ativar `is_enabled` ou limpar `disabled_networks` não cria uma adesão em falta.Para verificações que pode executar sem credenciais de rede, consulte [Testar sem credenciais de rede](https://docs.didit.me/pt/transaction-monitoring/travel-rule.md#testar-sem-credenciais-de-rede).


## OpenAPI

````yaml pt/openapi-25.json GET /v3/travel-rule/settings/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de Verificação de identidade. Autentique-se com o cabeçalho x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/travel-rule/settings/:
    get:
      tags:
        - Travel Rule
      summary: Obter definições de Travel Rule
      description: >-
        Leia as definições de Travel Rule da aplicação e o perfil VASP. Cria
        automaticamente uma linha de definições predefinida (desativada) e um
        perfil vazio na primeira leitura.
      operationId: getTravelRuleSettings
      responses:
        '200':
          description: Definições atuais da Travel Rule e perfil de VASP.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TravelRuleSettingsDetail'
              examples:
                Disabled (default):
                  value:
                    is_enabled: false
                    jurisdiction: EU
                    name_matching_strictness: DEFAULT
                    confirmation_timeout_hours: 48
                    timeout_outcome: HOLD
                    threshold_amount: '0.00'
                    inbound_auto_accept: true
                    allow_self_declaration: true
                    allow_screenshot_proof: true
                    auto_wallet_verification: true
                    vasp_attribution_enabled: true
                    legal_name: ''
                    lei: ''
                    compliance_email: ''
                    is_discoverable: true
                    counterparty_screening_enabled: false
                    sunrise_policy: ''
                    sunrise_jurisdictions:
                      - CO
                      - KH
                      - VN
                    non_responsive_policy: ''
                    travel_address: ''
                    disabled_networks: []
                    networks:
                      gtr:
                        rail: GTR
                        mode: unavailable
                        state: didit_onboarding
                        reason: didit_membership_not_live
                        platform_available: false
                        connected: false
                        participant: null
                        vasps_reachable: 0
                        routed_30d: 0
                      trust:
                        rail: TRUST
                        mode: unavailable
                        state: unavailable
                        reason: own_membership_only
                        platform_available: false
                        connected: false
                        participant: null
                        vasps_reachable: 0
                        routed_30d: 0
                      verifyvasp:
                        rail: VERIFYVASP
                        mode: unavailable
                        state: didit_onboarding
                        reason: didit_membership_not_live
                        platform_available: false
                        connected: false
                        participant: null
                        vasps_reachable: 0
                        routed_30d: 0
                      sygna:
                        rail: SYGNA
                        mode: unavailable
                        state: didit_onboarding
                        reason: didit_membership_not_live
                        platform_available: false
                        connected: false
                        participant: null
                        vasps_reachable: 0
                        routed_30d: 0
                    didit_network:
                      listed: false
                      missing:
                        - travel_rule_off
                        - legal_name_missing
                        - compliance_email_missing
                      compliance_email_confirmed: false
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: |-
            curl -X GET https://verification.didit.me/v3/travel-rule/settings/ \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.travel_rule.retrieve_settings()
            print(result)
        - lang: javascript
          label: Node.js
          source: |-
            import Didit from "@didit-protocol/sdk-node";

            // Reads DIDIT_API_KEY.
            const didit = new Didit();

            const result = await didit.travelRule.retrieveSettings();
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.RetrieveSettings(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: |-
            import me.didit.Didit;

            // Reads DIDIT_API_KEY.
            Didit client = new Didit();

            var result = client.travelRule().retrieveSettings();
            System.out.println(result);
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            $result = $didit->travelRule->retrieveSettings();
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            result = didit.travel_rule.retrieve_settings
            puts result.to_h
        - lang: csharp
          label: .NET
          source: |-
            using System;
            using System.Text.Json;
            using Didit;

            // Reads DIDIT_API_KEY.
            using var client = new DiditClient();

            var result = await client.TravelRule.RetrieveSettingsAsync();
            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    TravelRuleSettingsDetail:
      type: object
      properties:
        is_enabled:
          type: boolean
          description: >-
            Indica se o fluxo de negociação gerida de Travel Rule está ativo
            para transações de saída `travelRule` nesta aplicação.
        jurisdiction:
          type: string
          maxLength: 8
          description: >-
            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.
        name_matching_strictness:
          type: string
          enum:
            - NONE
            - STRICT
            - CONTAINS
            - DEFAULT
            - FUZZY
          description: >-
            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.
        confirmation_timeout_hours:
          type: integer
          minimum: 1
          description: >-
            Horas que uma transferência AWAITING_COUNTERPARTY pode permanecer
            por confirmar antes de o processo periódico de limpeza a expirar.
            Predefinição: 48.
        timeout_outcome:
          type: string
          enum:
            - HOLD
            - REJECT
            - PROCEED
          description: >-
            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.
        threshold_amount:
          type: string
          description: >-
            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:
          type: string
          enum:
            - FULL
            - SIMPLIFIED
            - AUTOMATED
          description: >-
            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`.
        simplified_validation_threshold:
          type: string
          description: >-
            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:
          $ref: '#/components/schemas/TravelRuleDataSharingFields'
        matching_rules:
          $ref: '#/components/schemas/TravelRuleMatchingRules'
        legal_name:
          type: string
          description: >-
            A denominação social do seu VASP. Obrigatória (não vazia) para
            definir is_enabled como true.
        lei:
          type: string
          description: >-
            O seu Identificador de Entidade Jurídica (LEI), apresentado no
            diretório de VASP.
        compliance_email:
          type: string
          format: email
          description: >-
            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:
          type: boolean
          description: >-
            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:
          type: boolean
          description: >-
            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:
          type: boolean
          description: >-
            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:
          type: boolean
          description: >-
            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:
          type: boolean
          description: >-
            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:
          type: boolean
          description: >-
            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:
          type: boolean
          description: >-
            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:
          type: string
          enum:
            - ''
            - HOLD
            - REJECT
            - PROCEED
          description: >-
            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.
        sunrise_jurisdictions:
          type: array
          items:
            type: string
          readOnly: true
          description: >-
            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:
          type: string
          enum:
            - ''
            - HOLD
            - REJECT
            - PROCEED
          description: >-
            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.
        travel_address:
          type: string
          description: >-
            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:
          type: array
          items:
            type: string
            enum:
              - GTR
              - TRUST
              - VERIFYVASP
              - SYGNA
          description: >-
            Redes que optaram por não aderir à plataforma. Não desativa as suas
            adesões próprias associadas nem disponibiliza redes indisponíveis.
          default: []
        networks:
          type: object
          readOnly: true
          description: >-
            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.
          properties:
            gtr:
              $ref: '#/components/schemas/TravelRuleNetworkState'
            trust:
              $ref: '#/components/schemas/TravelRuleNetworkState'
            verifyvasp:
              $ref: '#/components/schemas/TravelRuleNetworkState'
            sygna:
              $ref: '#/components/schemas/TravelRuleNetworkState'
        didit_network:
          type: object
          readOnly: true
          description: >-
            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.
          properties:
            listed:
              type: boolean
            missing:
              type: array
              items:
                type: string
                enum:
                  - travel_rule_off
                  - sandbox_application
                  - not_discoverable
                  - legal_name_missing
                  - compliance_email_missing
                  - compliance_email_unconfirmed
                  - excluded_by_staff
                  - internal_organization
              description: >-
                Vazio quando listado. compliance_email_unconfirmed: envie a
                confirmação com POST
                /v3/travel-rule/settings/compliance-email/confirmation/ e abra a
                ligação enviada por e-mail. excluded_by_staff: a Didit marcou a
                aplicação como de teste, demonstração ou interna.
            compliance_email_confirmed:
              type: boolean
              description: >-
                Indica se o compliance_email atual foi confirmado através da
                ligação enviada por e-mail.
    TravelRuleDataSharingFields:
      type: object
      description: >-
        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.
      properties:
        individual:
          type: array
          items:
            type: string
            enum:
              - name
              - wallet_address
              - address
              - national_id
              - customer_identification
              - date_of_birth
              - place_of_birth
          description: Campos partilhados relativos a uma pessoa singular.
        company:
          type: array
          items:
            type: string
            enum:
              - name
              - wallet_address
              - address
              - national_id
              - customer_identification
          description: Campos partilhados relativos a uma pessoa coletiva.
    TravelRuleMatchingRules:
      type: object
      description: >-
        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).
      properties:
        individual:
          type: object
          description: Regras para uma pessoa singular.
          properties:
            name:
              type: string
              enum:
                - NONE
                - STRICT
                - CONTAINS
                - DEFAULT
                - FUZZY
              description: 'Predefinição: segue `name_matching_strictness`.'
            date_of_birth:
              type: string
              enum:
                - NONE
                - STRICT
                - CONTAINS
                - DEFAULT
                - FUZZY
              description: Predefinição `NONE`.
            address:
              type: string
              enum:
                - NONE
                - STRICT
                - CONTAINS
                - DEFAULT
                - FUZZY
              description: Predefinição `NONE`.
            account:
              type: string
              enum:
                - NONE
                - STRICT
                - CONTAINS
                - DEFAULT
                - FUZZY
              description: >-
                A carteira através da qual a exchange foi encaminhada.
                Predefinição `STRICT`.
        company:
          type: object
          description: Regras para uma pessoa coletiva.
          properties:
            name:
              type: string
              enum:
                - NONE
                - STRICT
                - CONTAINS
                - DEFAULT
                - FUZZY
              description: 'Predefinição: segue `name_matching_strictness`.'
            address:
              type: string
              enum:
                - NONE
                - STRICT
                - CONTAINS
                - DEFAULT
                - FUZZY
              description: Predefinição `NONE`.
            account:
              type: string
              enum:
                - NONE
                - STRICT
                - CONTAINS
                - DEFAULT
                - FUZZY
              description: >-
                A carteira através da qual a exchange foi encaminhada.
                Predefinição `STRICT`.
    TravelRuleNetworkState:
      type: object
      description: >-
        Como as mensagens da Travel Rule numa rede seriam enviadas para esta
        aplicação, e porque não podem sê-lo. Estado de configuração, não uma
        verificação de estado ou de entrega em direto.
      properties:
        rail:
          type: string
          enum:
            - GTR
            - TRUST
            - VERIFYVASP
            - SYGNA
        mode:
          type: string
          enum:
            - own
            - didit
            - 'off'
            - unavailable
          description: >-
            own: é utilizada a adesão associada da aplicação; didit: a adesão da
            Didit regista a aplicação como o seu próprio participante ativo;
            off: encaminhamento da plataforma desativado em disabled_networks
            sem adesão própria; unavailable: ainda nada pode enviar nesta rede
            (consulte state e reason).
        state:
          type: string
          enum:
            - own_membership
            - live_through_didit
            - 'off'
            - didit_onboarding
            - questionnaire_needed
            - questionnaire_in_review
            - request_access
            - request_sent
            - unavailable
            - error
          description: >-
            own_membership: a sua adesão associada envia; live_through_didit: o
            seu próprio participante na adesão da Didit envia; off: desativou o
            encaminhamento da plataforma; didit_onboarding: a adesão própria da
            Didit a esta rede ainda não está ativa, pelo que não pode
            transportar ninguém; questionnaire_needed / questionnaire_in_review:
            o questionário de diligência devida tem de ser submetido ou está com
            a Didit; request_access: o questionário está aprovado, solicite
            acesso à rede; request_sent: o seu participante está a passar pelo
            processo de onboarding; unavailable: consulte reason; error:
            consulte reason.
        reason:
          type: string
          enum:
            - own_membership_connected
            - platform_network_switched_off
            - own_membership_only
            - sandbox_application
            - didit_membership_not_live
            - participant_suspended
            - participant_rejected
            - questionnaire_not_submitted
            - questionnaire_submitted
            - questionnaire_changes_requested
            - questionnaire_rejected
            - participant_not_requested
            - participant_active
            - participant_key_missing
            - participant_key_unresolved
            - provisioning_failed
            - questionnaire_pending
            - submitted_to_network
          description: >-
            Detalhe do estado legível por máquina. own_membership_only: a Didit
            não suporta aplicações nesta rede (TRUST), associe a sua própria
            adesão; sandbox_application: as transferências em sandbox nunca
            chegam a uma rede; provisioning_failed: a rede recusou o registo, o
            last_error do participante indica o motivo e voltar a pedir à rede
            tenta novamente.
        platform_available:
          type: boolean
          description: >-
            Se a adesão da própria Didit a esta rede está configurada; não é uma
            verificação de estado em tempo real.
        connected:
          type: boolean
          description: >-
            Se existe uma adesão de cliente ligada. As credenciais são validadas
            localmente; a validação de rede ocorre numa troca em direto.
        participant:
          $ref: '#/components/schemas/TravelRuleNetworkParticipantSummary'
        vasps_reachable:
          type: integer
          description: VASPs do diretório acessíveis nesta rede.
        routed_30d:
          type: integer
          description: >-
            As transferências desta aplicação efetuadas nesta rede nos últimos
            30 dias.
    TravelRuleNetworkParticipantSummary:
      type: object
      nullable: true
      description: >-
        O participante próprio desta aplicação na rede, ou null quando não tiver
        nenhum.
      properties:
        mode:
          type: string
          enum:
            - platform
            - own
          description: >-
            platform: transportado pela adesão da Didit; own: integrado sob a
            adesão própria da aplicação.
        status:
          type: string
          enum:
            - not_requested
            - questionnaire_pending
            - submitted_to_network
            - active
            - suspended
            - rejected
          description: >-
            not_requested: nunca foi pedido, ou a rede recusou o primeiro pedido
            (consulte last_error); questionnaire_pending: a aguardar que o
            questionário de diligência devida seja aprovado;
            submitted_to_network: entregue ao onboarding da rede; active: a rede
            atribuiu a esta aplicação o seu próprio código de participante;
            suspended / rejected: a Didit suspendeu-a ou rejeitou-a.
        participant_code:
          type: string
          description: >-
            O código que a rede atribuiu a esta aplicação (para a GTR, o seu
            código de VASP). As mensagens enviadas contêm este código, nunca o
            da Didit.
        requested_at:
          type: string
          format: date-time
          nullable: true
        activated_at:
          type: string
          format: date-time
          nullable: true
        last_error:
          type: string
          description: >-
            A resposta da rede quando recusou o registo; vazia nos restantes
            casos.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.