> ## 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 para obter redes de Travel Rule

> Consulte na Didit o estado real de cada rede de Travel Rule na sua aplicação: sua adesão, a adesão da Didit ou por que a rede ainda não envia.

Prompt da API para obter as redes da Travel Rule
Copiar o prompt para a área de transferência

<pre>
  \`Read, for my application, the real state of every Travel Rule network, the due-diligence questionnaire and my participants.

  Endpoint:
  GET [https://verification.didit.me/v3/travel-rule/networks/](https://verification.didit.me/v3/travel-rule/networks/)

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

  What to read from the response:

  * platform\_networks\_enabled - whether network access through Didit's membership is open. While false, questionnaire saves, submissions and network requests answer 403.
  * networks - keyed by gtr/trust/verifyvasp/sygna: {rail, mode, state, reason, platform_available, connected, participant, vasps_reachable, routed_30d}.
  * state: own\_membership | live\_through\_didit | off | didit\_onboarding | questionnaire\_needed | questionnaire\_in\_review | request\_access | request\_sent | unavailable | error.
  * reason: the machine-readable detail, for example didit\_membership\_not\_live, own\_membership\_only (TRUST) or provisioning\_failed.
  * participant: my own participant on that network (status, participant\_code, last\_error), or null.
  * questionnaire - status (draft | submitted | changes\_requested | approved | rejected), answers and Didit's review\_note.
  * participants - every participant I have, with its status history.

  Reading creates nothing. Full guide: /transaction-monitoring/travel-rule.\`
</pre>

Colar em

## Estados da rede

Uma rede envia em nome da sua aplicação de uma de duas formas:

* **Sua própria associação** (`state: own_membership`): uma associação que você conectou no **Marketplace**. Ela sempre tem precedência.
* **Associação da Didit** (`state: live_through_didit`): a Didit leva sua aplicação como participante próprio na GTR ou na Sygna, com o código de participante que a rede atribuiu a você. As mensagens nunca levam o código da própria Didit, e o que a rede envia para o seu código de participante chega à sua aplicação.

Acessar uma rede pela associação da Didit exige três etapas: enviar o [questionário da rede](https://docs.didit.me/pt-br/management-api/travel-rule/submit-network-questionnaire.md), obter a aprovação da Didit e, em seguida, [solicitar acesso à rede](https://docs.didit.me/pt-br/management-api/travel-rule/request-network.md). A TRUST e a VerifyVASP só podem ser acessadas pela sua própria associação: a TRUST admite membros por VASP, e um Enclave da VerifyVASP atende a um único ID de VASP, por isso você opera o seu próprio.

Enquanto a associação da própria Didit a uma rede não estiver ativa, o `state` dessa rede é `didit_onboarding` e nada pode ser enviado nela por meio da Didit. O `state` é um status de configuração, não uma verificação em tempo real de status ou de entrega.


## OpenAPI

````yaml pt-br/openapi-25.json GET /v3/travel-rule/networks/
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/networks/:
    get:
      tags:
        - Travel Rule
      summary: Obter as redes de Travel Rule
      description: >-
        Leia, para esta aplicação, o estado real de cada rede: se ela envia pela
        sua própria adesão ou pela da Didit, e por que ainda não pode. Também
        retorna o questionário de due diligence e os seus participantes. A
        leitura não cria nada.
      operationId: getTravelRuleNetworks
      responses:
        '200':
          description: Estados da rede, questionário e participantes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TravelRuleNetworksOverview'
              examples:
                Before the questionnaire:
                  value:
                    platform_networks_enabled: false
                    questionnaire:
                      status: draft
                      answers: {}
                      submitted_at: null
                      reviewed_at: null
                      review_note: ''
                      history: []
                      updated_at: null
                    participants: []
                    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
        '401':
          description: Chave de API ausente ou inválida.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: |-
            curl -X GET https://verification.didit.me/v3/travel-rule/networks/ \
              -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.networks.retrieve()
            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.networks.retrieve();
            console.log(result);
        - lang: java
          label: Java
          source: |-
            import me.didit.Didit;

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

            var result = client.travelRule().networks().retrieve();
            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->networks->retrieve();
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

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

            result = didit.travel_rule.networks.retrieve
            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.Networks.RetrieveAsync();
            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    TravelRuleNetworksOverview:
      type: object
      properties:
        platform_networks_enabled:
          type: boolean
          description: >-
            Indica se o acesso à rede por meio da associação da Didit está
            aberto. Enquanto for false, salvamentos de questionários, envios e
            requisições à rede respondem 403.
        questionnaire:
          $ref: '#/components/schemas/TravelRuleNetworkQuestionnaire'
        participants:
          type: array
          items:
            $ref: '#/components/schemas/TravelRuleNetworkParticipant'
        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'
    TravelRuleNetworkQuestionnaire:
      type: object
      properties:
        status:
          type: string
          enum:
            - draft
            - submitted
            - changes_requested
            - approved
            - rejected
          description: >-
            As respostas podem ser salvas enquanto o status for draft ou
            changes_requested. Somente a Didit pode mudar o status para
            submitted, approved e rejected.
        answers:
          $ref: '#/components/schemas/TravelRuleNetworkQuestionnaireAnswers'
        submitted_at:
          type: string
          format: date-time
          nullable: true
        reviewed_at:
          type: string
          format: date-time
          nullable: true
        review_note:
          type: string
          description: >-
            Observação da Didit sobre a sua última decisão, por exemplo, o que
            alterar.
        history:
          type: array
          readOnly: true
          description: Todas as mudanças de status, da mais antiga para a mais recente.
          items:
            type: object
            properties:
              at:
                type: string
                format: date-time
              from:
                type: string
              to:
                type: string
              note:
                type: string
                description: Nota de revisão ou a resposta da rede, quando houver.
        updated_at:
          type: string
          format: date-time
          nullable: true
    TravelRuleNetworkParticipant:
      type: object
      description: O participante próprio desta aplicação em uma rede.
      properties:
        network:
          type: string
          enum:
            - gtr
            - trust
            - verifyvasp
            - sygna
        rail:
          type: string
          enum:
            - GTR
            - TRUST
            - VERIFYVASP
            - SYGNA
        mode:
          type: string
          enum:
            - platform
            - own
        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
        requested_at:
          type: string
          format: date-time
          nullable: true
        submitted_at:
          type: string
          format: date-time
          nullable: true
        activated_at:
          type: string
          format: date-time
          nullable: true
        suspended_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.
        history:
          type: array
          readOnly: true
          description: Todas as mudanças de status, da mais antiga para a mais recente.
          items:
            type: object
            properties:
              at:
                type: string
                format: date-time
              from:
                type: string
              to:
                type: string
              note:
                type: string
                description: Nota de revisão ou a resposta da rede, quando houver.
    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.
    TravelRuleNetworkQuestionnaireAnswers:
      type: object
      description: >-
        Questionário de due diligence da rede da Didit. Os salvamentos são
        parciais: cada salvamento mantém todas as respostas que não menciona. O
        envio exige todos os campos, exceto lei e data_protection_contact_email,
        e as três declarações como true.
      properties:
        legal_name:
          type: string
          maxLength: 255
        registration_number:
          type: string
          maxLength: 255
        incorporation_country:
          type: string
          minLength: 2
          maxLength: 2
          description: Código de país ISO 3166-1 alpha-2.
        registered_address:
          type: string
          maxLength: 1000
        website:
          type: string
          format: uri
          maxLength: 500
        lei:
          type: string
          maxLength: 20
          description: Opcional. Um LEI ISO 17442 válido, quando informado.
        licences:
          type: array
          minItems: 1
          items:
            type: object
            required:
              - regulator
              - jurisdiction
              - licence_type
              - licence_number
            properties:
              regulator:
                type: string
                maxLength: 255
              jurisdiction:
                type: string
                minLength: 2
                maxLength: 2
                description: Código de país ISO 3166-1 alpha-2.
              licence_type:
                type: string
                maxLength: 255
              licence_number:
                type: string
                maxLength: 255
          description: Todas as licenças ou registros que o VASP possui.
        operating_jurisdictions:
          type: array
          minItems: 1
          maxItems: 250
          items:
            type: string
            minLength: 2
            maxLength: 2
            description: Código de país ISO 3166-1 alpha-2.
        compliance_officer_name:
          type: string
          maxLength: 255
        compliance_officer_email:
          type: string
          format: email
        aml_ctf_policy_attested:
          type: boolean
          description: Deve ser true para enviar.
        sanctions_screening_attested:
          type: boolean
          description: Deve ser true para enviar.
        data_protection_attested:
          type: boolean
          description: Deve ser true para enviar.
        data_protection_contact_email:
          type: string
          format: email
          description: Opcional.
        expected_monthly_transfers:
          type: integer
          minimum: 0
        expected_monthly_volume_usd:
          type: string
          format: decimal
          description: >-
            Volume mensal esperado em USD, com até 2 casas decimais. Retornado
            como string.
        assets:
          type: array
          minItems: 1
          maxItems: 200
          items:
            type: string
            maxLength: 32
          description: >-
            Tickers dos ativos, armazenados em maiúsculas, ordenados e sem
            duplicatas.
    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.