> ## 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.

# API de configurações da Travel Rule: perfil de VASP

> Consulte via API da Didit a configuração da Travel Rule: perfil de VASP, política de negociação, métodos de prova, redes e travel address.



Prompt da API para obter as configuraçõ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 das redesGTR, TRUST, VerifyVASP e Sygna exigem uma filiação ativa.
Hoje a Didit não tem filiação de plataforma em nenhuma dessas redes; a Didit está em processo de onboarding como provedora.
Até lá, um canal de rede só faz o roteamento pela sua própria filiação, conectada em **Marketplace**.
Leia `networks` da aplicação que você está configurando:- **`own`** - A sua filiação conectada tem precedência, mesmo que a rede esteja em `disabled_networks`. As trocas usam a sua identidade na rede.
- **`didit`** - A filiação da Didit registra a sua aplicação como participante ativa da Didit nesta rede, com o código que a rede atribuiu a você.
  Não são necessárias credenciais de filiação do cliente para esta rede.
  Para chegar a este modo, é preciso preencher o questionário de rede da Didit e enviar uma solicitação à rede: consulte [Get Travel Rule Networks](https://docs.didit.me/pt-br/management-api/travel-rule/get-networks.md).
  O ambiente de produção ainda não informa este modo, porque a filiação própria da Didit não está ativa.
- **`off`** - Você desativou o roteamento pela plataforma e não tem uma filiação própria conectada. Remova a rede de `disabled_networks` para permitir o roteamento pela plataforma quando estiver disponível, ou conecte a sua própria filiação.
- **`unavailable`** - Ainda não é possível enviar nada nesta rede para a sua aplicação.
  `state` e `reason` informam o motivo: por exemplo, `didit_onboarding` enquanto a filiação própria da Didit na rede não está ativa, ou `questionnaire_needed` antes de o seu questionário ser aprovado.
  Hoje todas as redes informam este modo, a menos que você tenha conectado a sua própria filiação ou desativado a rede.
  Conecte a sua própria filiação em **Marketplace** ou use uma contraparte `INTERNAL`, `TRP` ou `EMAIL` acessível.`disabled_networks` afeta apenas a filiação de plataforma da Didit, que ainda não está disponível, portanto hoje não tem efeito no roteamento.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 de diretório](https://docs.didit.me/pt-br/transaction-monitoring/travel-rule.md#rotas) da contraparte a lista com um código nessa rede.Por meio da GTR, da VerifyVASP e da 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`.
A TRUST apenas envia: uma transferência enviada por ela permanece em `AWAITING_COUNTERPARTY` até que `confirmation_timeout_hours` se esgote e ela se torne `EXPIRED`, e então `timeout_outcome` se aplica.
Se a mensagem não puder ser entregue, a transferência passa para `COUNTERPARTY_VASP_NOT_REACHABLE`.
Consulte [Redes da Travel Rule](https://docs.didit.me/pt-br/transaction-monitoring/travel-rule-networks.md) para saber o que cada rede alcança hoje.`platform_available` é um status de configuração, não uma verificação em tempo real do status da rede. `connected` indica uma filiação salva que passou na validação local de credenciais, não uma troca bem-sucedida com o provedor. Ativar `is_enabled` ou limpar `disabled_networks` não provisiona uma filiação ausente.Para verificações que você pode executar sem credenciais de rede, consulte [Testes sem credenciais de rede](https://docs.didit.me/pt-br/transaction-monitoring/travel-rule.md#testes-sem-credenciais-de-rede).


## OpenAPI

````yaml pt-br/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 as configurações de Travel Rule
      description: >-
        Lê as configurações de Travel Rule e o perfil de VASP da aplicação. Na
        primeira leitura, cria automaticamente uma linha de configurações padrão
        (desativada) e um perfil vazio.
      operationId: getTravelRuleSettings
      responses:
        '200':
          description: Configuraçõ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: >-
            Se o fluxo gerenciado de negociação da Travel Rule está ativo para
            transações `travelRule` de saída nesta aplicação.
        jurisdiction:
          type: string
          maxLength: 8
          description: >-
            Código da jurisdição em que sua VASP opera. Padrão `"EU"`. A Didit o
            associa ao regime que registra nas suas transações de Travel Rule
            como `travel_rule_regime` (por exemplo, `EU` ou o código de um
            Estado-membro da UE se torna `eu`), que as regras de transação podem
            usar como critério. Outros clientes da Didit o veem como sua
            jurisdição no diretório de VASPs assim que a rede Didit listar seu
            perfil.
        name_matching_strictness:
          type: string
          enum:
            - NONE
            - STRICT
            - CONTAINS
            - DEFAULT
            - FUZZY
          description: >-
            Com que rigor os nomes dos beneficiários devem corresponder antes
            que uma transferência possa chegar a COMPLETED. `CONTAINS` aceita um
            nome cujas palavras aparecem todas no outro.
        confirmation_timeout_hours:
          type: integer
          minimum: 1
          description: >-
            Horas que uma transferência AWAITING_COUNTERPARTY pode permanecer
            sem confirmação antes que o processo periódico de varredura a
            expire. Padrão: 48.
        timeout_outcome:
          type: string
          enum:
            - HOLD
            - REJECT
            - PROCEED
          description: >-
            O que acontece com a transação subjacente quando uma transferência
            expira. Padrã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 padrão da sua aplicação. Valor mínimo de
            transferência que aciona uma troca gerenciada; transferências abaixo
            dele são resolvidas diretamente como NOT_APPLICABLE. A Didit compara
            o valor da transação convertido para a sua moeda padrão, ou o
            `amount_in_default_currency` que você envia; quando nenhum valor
            convertido está disponível, o limiar não se aplica. O padrão é
            "0.00" (o EU TFR não aplica valor mínimo).
        ownership_validation_mode:
          type: string
          enum:
            - FULL
            - SIMPLIFIED
            - AUTOMATED
          description: >-
            Quanta comprovação a propriedade de uma carteira exige. `FULL`
            sempre exige uma comprovação (mensagem assinada, depósito de teste
            ou captura de tela revisada), nunca a palavra do usuário final.
            `SIMPLIFIED` aceita uma autodeclaração abaixo de
            `simplified_validation_threshold` e uma comprovação acima dele.
            `AUTOMATED` permite que o catálogo de endereços e as comprovações
            anteriores respondam por conta própria, incluindo autodeclarações
            enquanto `allow_self_declaration` for true. Padrão `AUTOMATED`.
        simplified_validation_threshold:
          type: string
          description: >-
            String decimal, padrão "0.00". No modo `SIMPLIFIED`, uma
            transferência abaixo desse valor (na moeda do limiar) aceita uma
            autodeclaração. Uma transferência sem valor nessa moeda conta como
            acima dele.
        data_sharing_fields:
          $ref: '#/components/schemas/TravelRuleDataSharingFields'
        matching_rules:
          $ref: '#/components/schemas/TravelRuleMatchingRules'
        legal_name:
          type: string
          description: >-
            Razão social do seu VASP. Obrigatório (não pode ficar em branco)
            para definir is_enabled como true.
        lei:
          type: string
          description: Seu Legal Entity Identifier, exibido no diretório de VASPs.
        compliance_email:
          type: string
          format: email
          description: >-
            E-mail de contato de conformidade do seu perfil de VASP. A rede
            Didit só lista seu perfil depois que esse endereço é confirmado por
            meio de um link enviado por e-mail (POST
            /v3/travel-rule/settings/compliance-email/confirmation/); alterá-lo
            exige 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 da Didit e
            acessado pelo rail INTERNAL. A listagem também exige uma aplicação
            de produção, a Travel Rule ativada, uma razão social e um e-mail de
            conformidade confirmado; didit_network indica quais deles estão
            faltando. Padrão: true.
        inbound_auto_accept:
          type: boolean
          description: >-
            Quando verdadeiro, uma consulta TRP de entrada cuja carteira do
            beneficiário é uma entrada verificada do catálogo de endereços com
            nome correspondente é aprovada automaticamente. Quando falso, essa
            consulta fica em ON_HOLD até que você a aprove ou recuse com o
            endpoint de propriedade. Transferências pela via INTERNAL e após
            depósito não são afetadas. Padrão: verdadeiro.
        allow_self_declaration:
          type: boolean
          description: >-
            Quando verdadeiro, o widget de propriedade de carteira oferece a
            autodeclaração como método de prova alternativo. Padrão: verdadeiro.
        allow_screenshot_proof:
          type: boolean
          description: >-
            Quando verdadeiro, o widget de propriedade de carteira oferece o
            envio de captura de tela como método de evidência de propriedade.
            Padrão: verdadeiro.
        auto_wallet_verification:
          type: boolean
          description: >-
            Quando verdadeiro, o envio de uma transferência de saída da Travel
            Rule que exige prova de controle da carteira pelo usuário final cria
            automaticamente uma sessão do widget de propriedade de carteira
            vinculada à transação e a expõe no bloco action_required da
            transação. Padrão: verdadeiro.
        vasp_attribution_enabled:
          type: boolean
          description: >-
            Quando verdadeiro, uma transferência de saída da Travel Rule que
            nenhuma via consegue rotear é atribuída por meio de análise de
            blockchain: a carteira de destino é associada ao VASP que a
            controla, a entidade é registrada na transferência e no diretório de
            VASPs, e as vias são executadas novamente uma vez com o nome
            atribuído. Padrão: verdadeiro.
        counterparty_screening_enabled:
          type: boolean
          description: >-
            Análise opcional de sanções e mídia adversa de VASPs contraparte,
            cobrada por análise ao preço da Análise AML de empresas. Quando
            ativada, a Didit analisa a contraparte alcançada por uma troca de
            saída (reutilizando uma análise com menos de 30 dias) e você pode
            analisar uma com POST /v3/travel-rule/vasps/{vasp_id}/screening/.
            Padrão false: nada é analisado nem cobrado.
        sunrise_policy:
          type: string
          enum:
            - ''
            - HOLD
            - REJECT
            - PROCEED
          description: >-
            O efeito de uma transferência expirada sobre a sua transação quando
            a contraparte é uma entrada do diretório em uma jurisdição listada
            em sunrise_jurisdictions, que ainda não aplica a Travel Rule: HOLD a
            envia para revisão, REJECT a recusa, PROCEED mantém o status dela
            inalterado. Vazio (o padrão) segue timeout_outcome. Aplica-se antes
            de non_responsive_policy.
        sunrise_jurisdictions:
          type: array
          items:
            type: string
          readOnly: true
          description: >-
            Somente leitura. Os países (ISO 3166 alpha-2) que a Didit considera
            em período de sunrise da Travel Rule, nos quais sunrise_policy se
            aplica. Atualmente CO, KH e VN. Qualquer outra jurisdição, assim
            como uma vazia ou desconhecida, segue timeout_outcome.
        non_responsive_policy:
          type: string
          enum:
            - ''
            - HOLD
            - REJECT
            - PROCEED
          description: >-
            O efeito de uma transferência expirada sobre a sua transação quando
            a contraparte é uma entrada do diretório cuja responsividade é
            UNRESPONSIVE: HOLD, REJECT ou PROCEED, como em timeout_outcome.
            Vazio (o padrão) segue timeout_outcome. sunrise_policy se aplica
            primeiro quando ambas se encaixam.
        travel_address:
          type: string
          description: >-
            Somente leitura. O travel address do seu próprio VASP - o endpoint
            codificado de consultas TRP de entrada que outros VASPs usam para
            chegar até você. Vazio enquanto `is_enabled` for false.
        disabled_networks:
          type: array
          items:
            type: string
            enum:
              - GTR
              - TRUST
              - VERIFYVASP
              - SYGNA
          description: >-
            Redes em que a associação da plataforma foi desativada (opt-out).
            Não desativa as suas próprias associações conectadas nem provisiona
            redes indisponíveis.
          default: []
        networks:
          type: object
          readOnly: true
          description: >-
            Por rede, como esta aplicação faria o envio e por que não consegue.
            Nenhuma rede, incluindo a GTR, é incluída por padrão: uma rede fica
            acessível por meio da sua própria associação conectada, ou por meio
            da associação da Didit assim que a associação da Didit a essa rede
            estiver ativa e o seu próprio participante nela estiver ativo. Não é
            uma verificação em tempo real de funcionamento ou de entrega.
          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: >-
            Se a rede Didit lista o seu perfil de VASP, para que outros clientes
            da Didit o encontrem no diretório e o alcancem pelo trilho INTERNAL,
            e cada condição que ainda não é atendida.
          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 o
                link recebido por e-mail. excluded_by_staff: a Didit marcou a
                aplicação como de teste, de demonstração ou interna.
            compliance_email_confirmed:
              type: boolean
              description: >-
                Se o compliance_email atual foi confirmado pelo link enviado por
                e-mail.
    TravelRuleDataSharingFields:
      type: object
      description: >-
        Os campos que a Didit envia à VASP contraparte sobre seus próprios
        usuários, por tipo de entidade. O `name` e o `wallet_address` são sempre
        enviados, independentemente do que a lista diga. Um tipo de entidade que
        você nunca escolheu compartilha todos os campos. Uma lista vazia também
        é uma escolha: ela compartilha 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 compartilhados sobre uma pessoa física.
        company:
          type: array
          items:
            type: string
            enum:
              - name
              - wallet_address
              - address
              - national_id
              - customer_identification
          description: Campos compartilhados sobre uma pessoa jurídica.
    TravelRuleMatchingRules:
      type: object
      description: >-
        Com que rigor cada campo dos dados da contraparte é comparado com o que
        você possui, por tipo de entidade. Um campo que você omitir mantém o
        padrão. `NONE` ignora a comparação, `STRICT` exige exatamente as mesmas
        palavras, `CONTAINS` aceita um valor cujas palavras aparecem todas no
        outro, `DEFAULT` é a correspondência padrão por subconjunto e `FUZZY`
        aceita grafias próximas (e, para datas de nascimento, dia e mês
        invertidos).
      properties:
        individual:
          type: object
          description: Regras para uma pessoa física.
          properties:
            name:
              type: string
              enum:
                - NONE
                - STRICT
                - CONTAINS
                - DEFAULT
                - FUZZY
              description: 'Padrão: segue `name_matching_strictness`.'
            date_of_birth:
              type: string
              enum:
                - NONE
                - STRICT
                - CONTAINS
                - DEFAULT
                - FUZZY
              description: Padrão `NONE`.
            address:
              type: string
              enum:
                - NONE
                - STRICT
                - CONTAINS
                - DEFAULT
                - FUZZY
              description: Padrão `NONE`.
            account:
              type: string
              enum:
                - NONE
                - STRICT
                - CONTAINS
                - DEFAULT
                - FUZZY
              description: A carteira pela qual a troca foi roteada. Padrão `STRICT`.
        company:
          type: object
          description: Regras para uma pessoa jurídica.
          properties:
            name:
              type: string
              enum:
                - NONE
                - STRICT
                - CONTAINS
                - DEFAULT
                - FUZZY
              description: 'Padrão: segue `name_matching_strictness`.'
            address:
              type: string
              enum:
                - NONE
                - STRICT
                - CONTAINS
                - DEFAULT
                - FUZZY
              description: Padrão `NONE`.
            account:
              type: string
              enum:
                - NONE
                - STRICT
                - CONTAINS
                - DEFAULT
                - FUZZY
              description: A carteira pela qual a troca foi roteada. Padrão `STRICT`.
    TravelRuleNetworkState:
      type: object
      description: >-
        Como as mensagens da Travel Rule em uma rede seriam enviadas para esta
        aplicação e por que não podem ser. É o status da configuração, não uma
        verificação em tempo real de funcionamento ou de entrega.
      properties:
        rail:
          type: string
          enum:
            - GTR
            - TRUST
            - VERIFYVASP
            - SYGNA
        mode:
          type: string
          enum:
            - own
            - didit
            - 'off'
            - unavailable
          description: >-
            own: é usada a associação conectada da aplicação; didit: a
            associação da Didit inclui a aplicação como participante ativo
            próprio; off: roteamento pela plataforma desativado em
            disabled_networks, sem associação própria; unavailable: nada pode
            enviar por esta rede ainda (veja 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: sua associação conectada envia; live_through_didit:
            seu próprio participante na associação da Didit envia; off: você
            desativou o roteamento pela plataforma; didit_onboarding: a
            associação da própria Didit nesta rede ainda não está ativa, então
            não pode atender ninguém; questionnaire_needed /
            questionnaire_in_review: o questionário de due diligence precisa ser
            enviado ou está com a Didit; request_access: o questionário foi
            aprovado, solicite a rede; request_sent: seu participante está
            passando pelo onboarding; unavailable: veja reason; error: veja
            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 legível por máquina do estado. own_membership_only: a Didit
            não registra aplicações nesta rede (TRUST), conecte sua própria
            associação; sandbox_application: transferências de sandbox nunca
            chegam a uma rede; provisioning_failed: a rede recusou o registro, o
            last_error do participante informa o motivo e solicitar a rede
            novamente faz uma nova tentativa.
        platform_available:
          type: boolean
          description: >-
            Indica se a associação da própria Didit a esta rede está
            configurada; não é uma verificação de integridade em tempo real.
        connected:
          type: boolean
          description: >-
            Indica se existe uma associação de cliente conectada. As credenciais
            são validadas localmente; a validação na rede ocorre em uma troca
            real.
        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 realizadas 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
        houver.
      properties:
        mode:
          type: string
          enum:
            - platform
            - own
          description: >-
            platform: operado pela associação da Didit; own: com onboarding
            feito sob a associação própria da aplicação.
        status:
          type: string
          enum:
            - not_requested
            - questionnaire_pending
            - submitted_to_network
            - active
            - suspended
            - rejected
          description: >-
            not_requested: nunca solicitado, ou a rede recusou a primeira
            requisição (veja last_error); questionnaire_pending: aguardando a
            aprovação do questionário de due diligence; submitted_to_network:
            encaminhado ao onboarding da rede; active: a rede atribuiu a esta
            aplicação seu próprio código de participante; suspended / rejected:
            a Didit suspendeu ou rejeitou.
        participant_code:
          type: string
          description: >-
            O código que a rede atribuiu a esta aplicação (no GTR, o código VASP
            dela). As mensagens enviadas levam este código, nunca o da própria
            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 ela recusou o registro; vazio nos demais
            casos.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Chave de API da sua aplicação, em Developers -> API keys no Business
        Console. A chave principal tem acesso total. Uma chave nomeada pode ter
        escopo restrito: nenhum acesso, 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á errada, 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 a requisição veio de um
        endereço fora da sua lista de IPs; 404 em uma rota de sessão significa
        que a sessão está fora dos fluxos ou status da chave. Uma chave sem
        acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave
        sem permissão de escrita em sessões recebe links e tokens de sessão como
        null. Consulte https://docs.didit.me/console/api-keys.

````

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