> ## 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 por e-mail link do usuário final

> Crie na Didit um link do Travel Rule para o usuário final ou envie-o por e-mail ao endereço registrado, com validade, revogação e status de entrega.

A API de link de usuário final da Travel Rule da Didit emite um link para que o usuário escolha a carteira ou a contraparte, e pode enviá-lo por e-mail ao endereço registrado.

Envie `{"channel": "link"}` para copiar um link, ou `{"channel": "email"}` para também tentar o envio por e-mail. Se `channel` for omitido, o padrão é `link`. O e-mail usa o endereço do usuário final registrado na Didit e o idioma da sessão de verificação, quando disponível. Não é possível informar um destinatário arbitrário.

A API exige acesso de gravação 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`. Em outros estados, a resposta é `409`. Uma transação desconhecida ou uma transferência inexistente retorna `404`.

A resposta contém `end_user_link`, `expires_at`, `emailed_to` e `email_available`. Um novo link revoga os links de usuário final abertos anteriormente para essa transferência. Compartilhe-o somente com o usuário final pretendido.

Quando não existe e-mail registrado, `channel: email` retorna `409` com `code: end_user_email_missing`. Nesse caso, solicite `channel: link`. Se o envio falhar, a API ainda retorna um link 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 usuário durante a criação, consulte [Criar uma transação](https://docs.didit.me/pt-br/management-api/transactions/create.md) e o [guia da Travel Rule](https://docs.didit.me/pt-br/transaction-monitoring/travel-rule.md#descoberta-de-contraparte). Para ações sobre a transferência, consulte [Atualizar uma transferência](https://docs.didit.me/pt-br/management-api/travel-rule/update-transfer.md).


## OpenAPI

````yaml pt-br/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 um link de Travel Rule para usuário final
      description: >-
        Emite um novo link e revoga os links abertos anteriores desta
        transferência. Requer acesso de escrita às 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 usuário
        final no registro da Didit e o idioma da sessão de verificação, quando
        disponíveis. Uma falha no envio retorna o link com emailed_to vazio;
        email_available indica a disponibilidade do endereço, não a entrega.
        Veja [Links do
        usuário](/pt-br/management-api/travel-rule/create-user-link).
      operationId: createTravelRuleUserLink
      parameters:
        - name: transaction_id
          in: path
          required: true
          description: UUID estável da transação na Didit à qual a transferência pertence.
          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 da requisição inválidos.
        '403':
          description: Permissão para gravar transações ausente.
        '404':
          description: Transação desconhecida ou sem transferência da Travel Rule.
        '409':
          description: >-
            A direção/status da transferência não permite o vínculo, ou
            channel=email não tem endereço do usuário final. Neste último caso,
            code=end_user_email_missing; tente novamente 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 retorna um novo link; email também tenta enviá-lo para o e-mail
            do registro do usuário final na Didit.
          enum:
            - link
            - email
          default: link
    TravelRuleUserLinkResponse:
      type: object
      properties:
        end_user_link:
          type: string
          description: >-
            Novo link para o usuário final. Os links abertos anteriores desta
            transferência são revogados.
          format: uri
        expires_at:
          type: string
          description: Expiração do link.
          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 ainda retorna um link utilizável.
        email_available:
          type: boolean
          description: Se o usuário final tem um e-mail no seu registro da Didit.
      required:
        - end_user_link
        - expires_at
        - emailed_to
        - email_available
  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.