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

# トラベルルールの認証リンクを作成・メール送信

> Didit のAPIで、トラベルルールの認証リンクを新規発行したり、ユーザーの登録済みアドレスへメール送信したりできます。リンクの有効期限、無効化、送信結果のフィールドを含みます。

Didit のトラベルルール向けエンドユーザーリンク API は、ユーザーがウォレットまたは取引相手の選択を完了するためのリンクを発行します。このリンクは、登録されているメールアドレス宛てに送信することもできます。

`{"channel": "link"}` を送信するとリンクをコピーできます。`{"channel": "email"}` を送信すると、メール配信も試行されます。`channel` を省略した場合の既定値は `link` です。メールは、エンドユーザーの Didit 登録メールアドレスと、利用可能な場合は認証セッションの言語を使って送信されます。任意の宛先を指定することはできません。

この API には、取引への書き込み権限と、次のいずれかの状態にある出金トランザクションが必要です: `AWAITING_COUNTERPARTY`、`COUNTERPARTY_VASP_NOT_FOUND`、`COUNTERPARTY_VASP_NOT_REACHABLE`、`UNCONFIRMED_OWNERSHIP`、`ON_HOLD`。それ以外の状態では `409` を返します。存在しない取引、または送金が見つからない場合は `404` を返します。

レスポンスには `end_user_link`、`expires_at`、`emailed_to`、`email_available` が含まれます。新しいリンクを発行すると、その送金に対して以前の有効なエンドユーザーリンクはすべて無効になります。発行したリンクは、意図したエンドユーザーにのみ共有してください。

登録済みのメールアドレスがない場合、`channel: email` は `code: end_user_email_missing` を含む `409` を返します。その場合は、代わりに `channel: link` をリクエストしてください。送信に失敗した場合も、API は利用可能なリンクを返しますが、`emailed_to` は空になります。`email_available` は、メールアドレスが存在することを示すもので、配信が成功したことを示すものではありません。

作成時にユーザーの選択を明示的に指定する方法については、[取引の作成](https://docs.didit.me/ja/management-api/transactions/create.md)と[トラベルルールガイド](https://docs.didit.me/ja/transaction-monitoring/travel-rule.md#取引相手の探索)を参照してください。送金に対する操作については、[送金の更新](https://docs.didit.me/ja/management-api/travel-rule/update-transfer.md)を参照してください。


## OpenAPI

````yaml ja/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。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: Travel Ruleのエンドユーザー向けリンクを作成またはメール送信
      description: >-
        この送金について新しいリンクを発行し、以前の未完了リンクをすべて無効化します。取引への書き込みアクセス権が必要で、送信送金の状態がAWAITING_COUNTERPARTY、COUNTERPARTY_VASP_NOT_FOUND、COUNTERPARTY_VASP_NOT_REACHABLE、UNCONFIRMED_OWNERSHIP、ON_HOLDのいずれかである必要があります。channel=emailの場合、利用可能であればエンドユーザーのDiditレコードのメールアドレスと認証セッションの言語を使用します。送信に失敗した場合は、emailed_toが空の状態でリンクが返されます。email_availableはアドレスが利用可能かどうかを示すもので、配信の成否は示しません。詳細は[ユーザーリンク](/ja/management-api/travel-rule/create-user-link)を参照してください。
      operationId: createTravelRuleUserLink
      parameters:
        - name: transaction_id
          in: path
          required: true
          description: この送金を所有する取引の、Diditの安定したUUIDです。
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TravelRuleUserLinkRequest'
            example:
              channel: link
      responses:
        '200':
          description: 成功レスポンス。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TravelRuleUserLinkResponse'
        '400':
          description: リクエストフィールドが無効です。
        '403':
          description: 取引を書き込む権限が不足しています。
        '404':
          description: 不明なトランザクション、またはトラベルルール送金がありません。
        '409':
          description: >-
            送金の方向またはステータスではリンクできないか、channel=emailの場合にエンドユーザーのメールアドレスがありません。後者の場合、code=end_user_email_missing
            となります。channel=linkで再試行してください。
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: 競合の説明。
                  code:
                    type: string
                    description: メールを利用できない場合に存在します。
                    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は新しいリンクを返します。emailは、エンドユーザーのDiditの記録にあるメールアドレスへの送信も試みます。
          enum:
            - link
            - email
          default: link
    TravelRuleUserLinkResponse:
      type: object
      properties:
        end_user_link:
          type: string
          description: 新しいエンドユーザーのリンクです。この取引の以前の未完了のリンクはすべて取り消されます。
          format: uri
        expires_at:
          type: string
          description: リンクの有効期限です。
          format: date-time
        emailed_to:
          type: string
          description: 送信に成功した場合は受信者、それ以外の場合は空文字列。メール送信に失敗しても、利用可能なリンクは返されます。
        email_available:
          type: boolean
          description: エンドユーザーの Didit レコードにメールアドレスがあるかどうか。
      required:
        - end_user_link
        - expires_at
        - emailed_to
        - email_available
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API
        keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権（なし、読み取り、書き込み）、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください:
        https://docs.didit.me/console/api-keys

````

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