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

# Travel Rule: criar ou enviar ligação ao utilizador final

> Crie na Didit uma ligação Travel Rule para o utilizador final ou envie-a por e-mail, com validade, revogação e estado da entrega.

A API de ligações para utilizadores finais da Travel Rule da Didit emite uma ligação para que o utilizador conclua a escolha da carteira ou da contraparte, e pode enviá-la por e-mail para o endereço de e-mail registado.

Envie `{"channel": "link"}` para copiar uma ligação, ou `{"channel": "email"}` para também tentar a entrega por e-mail. Se omitir `channel`, o valor por defeito é `link`. O e-mail usa o endereço do utilizador final no registo da Didit e o idioma da sessão de verificação, quando disponível. Não pode indicar um destinatário arbitrário.

A API requer acesso de escrita a transações e a uma transferência de saída nos estados `AWAITING_COUNTERPARTY`, `COUNTERPARTY_VASP_NOT_FOUND`, `COUNTERPARTY_VASP_NOT_REACHABLE`, `UNCONFIRMED_OWNERSHIP` ou `ON_HOLD`. Os restantes estados devolvem `409`; uma transação desconhecida ou uma transferência em falta devolve `404`.

A resposta contém `end_user_link`, `expires_at`, `emailed_to` e `email_available`. Uma nova ligação revoga as ligações de utilizador final abertas anteriormente para essa transferência. Partilhe-a apenas com o utilizador final pretendido.

Quando não existe um e-mail registado, `channel: email` devolve `409` com `code: end_user_email_missing`; em vez disso, envie `channel: link`. Se o envio falhar, a API continua a devolver uma ligação utilizável, com `emailed_to` vazio. `email_available` indica que existe um endereço, não que a entrega foi bem-sucedida.

Para a escolha explícita do utilizador durante a criação, veja [Criar uma transação](https://docs.didit.me/pt/management-api/transactions/create.md) e o [guia da Travel Rule](https://docs.didit.me/pt/transaction-monitoring/travel-rule.md#descoberta-de-contraparte). Para ações sobre transferências, veja [Atualizar uma transferência](https://docs.didit.me/pt/management-api/travel-rule/update-transfer.md).


## OpenAPI

````yaml pt/openapi-25.json POST /v3/transactions/{transaction_id}/travel-rule/user-link/
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/transactions/{transaction_id}/travel-rule/user-link/:
    post:
      tags:
        - Travel Rule
      summary: >-
        Criar ou enviar por e-mail uma ligação do utilizador final para a Travel
        Rule
      description: >-
        Emite uma nova ligação e revoga as ligações abertas anteriores para esta
        transferência. Requer acesso de escrita a transações e uma transferência
        de saída em AWAITING_COUNTERPARTY, COUNTERPARTY_VASP_NOT_FOUND,
        COUNTERPARTY_VASP_NOT_REACHABLE, UNCONFIRMED_OWNERSHIP ou ON_HOLD.
        channel=email usa o e-mail do utilizador final no registo Didit e o
        idioma da sessão de verificação, quando disponíveis. Uma falha no envio
        devolve a ligação com emailed_to vazio; email_available indica a
        disponibilidade do endereço, não a entrega. Consulte [Ligações de
        utilizador](/pt/management-api/travel-rule/create-user-link).
      operationId: createTravelRuleUserLink
      parameters:
        - name: transaction_id
          in: path
          required: true
          description: UUID de transação estável da Didit proprietário da transferência.
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TravelRuleUserLinkRequest'
            example:
              channel: link
      responses:
        '200':
          description: Resposta bem-sucedida.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TravelRuleUserLinkResponse'
        '400':
          description: Campos do pedido inválidos.
        '403':
          description: Falta a permissão para registar transações.
        '404':
          description: Transação desconhecida ou sem transferência Travel Rule.
        '409':
          description: >-
            A direção ou o estado da transferência não permite uma ligação, ou
            channel=email não tem endereço de utilizador final. Neste último
            caso, code=end_user_email_missing; repita com channel=link.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Explicação do conflito.
                  code:
                    type: string
                    description: Presente quando o e-mail não está disponível.
                    enum:
                      - end_user_email_missing
                required:
                  - detail
              example:
                detail: >-
                  This end user has no email on their Didit record. Copy the
                  link instead.
                code: end_user_email_missing
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X POST
            'https://verification.didit.me/v3/transactions/{transaction_id}/travel-rule/user-link/'
            \
              -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \
              -d '{"channel": "link"}'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.transactions.travel_rule.create_user_link(
                "11111111-2222-3333-4444-555555555555",
                channel="link",
            )
            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.transactions.travelRule.createUserLink("11111111-2222-3333-4444-555555555555",
            {
              channel: "link",
            });

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.TravelRule.CreateUserLink(ctx, \"11111111-2222-3333-4444-555555555555\", didit.TravelRuleUserLinkRequest{\n\tChannel: didit.Some(didit.TravelRuleUserLinkRequestChannel(\"link\")),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;

            import me.didit.types.TravelRuleUserLinkRequest;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.transactions().travelRule().createUserLink("11111111-2222-3333-4444-555555555555",
            TravelRuleUserLinkRequest.builder()
                    .channel(TravelRuleUserLinkRequest.Channel.of("link"))
                    .build());
            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->transactions->travelRule->createUserLink('11111111-2222-3333-4444-555555555555',
            [
                'channel' => 'link',
            ]);

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

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

            result = didit.transactions.travel_rule.create_user_link(
              "11111111-2222-3333-4444-555555555555",
              channel: "link"
            )
            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.Transactions.TravelRule.CreateUserLinkAsync("11111111-2222-3333-4444-555555555555",
            new TravelRuleUserLinkRequest

            {
                Channel = new TravelRuleUserLinkRequestChannel("link"),
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    TravelRuleUserLinkRequest:
      type: object
      properties:
        channel:
          type: string
          description: >-
            link devolve uma nova ligação; email também tenta enviá-la para o
            e-mail do registo Didit do utilizador final.
          enum:
            - link
            - email
          default: link
    TravelRuleUserLinkResponse:
      type: object
      properties:
        end_user_link:
          type: string
          description: >-
            Nova ligação para o utilizador final. As ligações abertas anteriores
            desta transferência são revogadas.
          format: uri
        expires_at:
          type: string
          description: Expiração da ligação.
          format: date-time
        emailed_to:
          type: string
          description: >-
            Destinatário quando o envio foi bem-sucedido; caso contrário, uma
            string vazia. Uma falha no e-mail continua a devolver uma ligação
            utilizável.
        email_available:
          type: boolean
          description: Se o utilizador final tem um e-mail no seu registo Didit.
      required:
        - end_user_link
        - expires_at
        - emailed_to
        - email_available
  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.