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

# Pedir acesso à rede Travel Rule na API de Gestão

> Peça à Didit que leve a sua aplicação à GTR ou à Sygna como participante próprio, depois de o seu questionário ser aprovado.

Prompt para solicitar uma API de rede Travel Rule
Copiar o prompt para a área de transferência

<pre>
  \`Ask Didit to carry my application on a Travel Rule network as my own participant.

  Endpoint:
  POST [https://verification.didit.me/v3/travel-rule/networks/\{network}/request/](https://verification.didit.me/v3/travel-rule/networks/\{network}/request/)
  network: gtr | sygna

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

  Behavior:

  * Without an approved questionnaire, the participant waits for it (status questionnaire\_pending).
  * With one, it goes to the network's onboarding (submitted\_to\_network) and becomes active once the network gives it a participant code.
  * Idempotent: a pending, onboarding or active participant is returned unchanged.
  * If the network refused the registration (last\_error is set and the network's state is error / provisioning\_failed), requesting again retries.
  * 400 travel\_rule\_network\_own\_membership\_only for TRUST and VerifyVASP (connect your own membership instead), 400 travel\_rule\_network\_sandbox\_application from a sandbox application, 403 travel\_rule\_platform\_networks\_disabled until network access through Didit opens.

  What to read from the response:

  * status, participant\_code, last\_error and history of my participant.

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

Colar em

Consulte o resultado em [Obter redes Travel Rule](https://docs.didit.me/pt/management-api/travel-rule/get-networks.md): o `state` da rede passa a `live_through_didit` quando o seu participante estiver ativo e a adesão da Didit a essa rede estiver ativa.


## OpenAPI

````yaml pt/openapi-25.json POST /v3/travel-rule/networks/{network}/request/
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/{network}/request/:
    post:
      tags:
        - Travel Rule
      summary: Pedir uma rede Travel Rule
      description: >-
        Pedir o participante próprio desta aplicação numa rede suportada pela
        adesão da Didit (GTR ou Sygna). Sem um questionário aprovado, o
        participante fica a aguardar pelo mesmo (questionnaire_pending); com
        este aprovado, segue para o onboarding da rede (submitted_to_network) e
        torna-se ativo assim que a rede lhe atribuir um código. Idempotente: um
        participante pendente, em onboarding ou em produção é devolvido
        inalterado. Se a rede recusou o registo (last_error definido), efetuar
        novo pedido tenta novamente. O TRUST e o VerifyVASP só estão acessíveis
        através da sua própria adesão: o TRUST admite membros por VASP e um
        Enclave VerifyVASP serve um ID de VASP.
      operationId: requestTravelRuleNetworkAccess
      parameters:
        - name: network
          in: path
          required: true
          schema:
            type: string
            enum:
              - gtr
              - sygna
          description: A rede à qual aderir através da adesão da Didit.
      responses:
        '200':
          description: O seu participante na rede.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TravelRuleNetworkParticipant'
        '400':
          description: >-
            Rede desconhecida, uma rede que a Didit não suporta (associe a sua
            própria adesão) ou uma aplicação sandbox.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                  code:
                    type: string
                    enum:
                      - travel_rule_network_own_membership_only
                      - travel_rule_network_sandbox_application
        '401':
          description: Chave de API em falta ou inválida.
        '403':
          description: O acesso à rede através da adesão da Didit ainda não está aberto.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                  code:
                    type: string
                    enum:
                      - travel_rule_platform_networks_disabled
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X POST
            https://verification.didit.me/v3/travel-rule/networks/gtr/request/ \
              -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.request_access(
                "your-network",
            )
            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.requestAccess("your-network");

            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().requestAccess("your-network");

            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->requestAccess('your-network');

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

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

            result = didit.travel_rule.networks.request_access("your-network")
            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.RequestAccessAsync("your-network");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    TravelRuleNetworkParticipant:
      type: object
      description: O participante próprio desta aplicação numa 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 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
        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 recusou o registo; vazia nos restantes
            casos.
        history:
          type: array
          readOnly: true
          description: Cada alteração de estado, 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 resposta da rede, quando existir.
  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.