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

> Diditに依頼して、アプリケーションをGTRまたはSygna上の独自の参加者として扱ってもらいます。依頼は質問票の承認後に行えます。

トラベルルールネットワークをリクエストするAPIプロンプト
プロンプトをクリップボードにコピー

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

貼り付け先

結果は[Get Travel Rule Networks](https://docs.didit.me/ja/management-api/travel-rule/get-networks.md)で確認できます。参加者が有効になり、そのネットワークにおけるDiditのメンバーシップが有効になると、ネットワークの`state`は`live_through_didit`になります。


## OpenAPI

````yaml ja/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。x-api-keyヘッダーで認証します。
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/travel-rule/networks/{network}/request/:
    post:
      tags:
        - Travel Rule
      summary: トラベルルールネットワークをリクエストする
      description: >-
        Diditのメンバーシップが対象とするネットワーク(GTRまたはSygna)上で、このアプリケーション独自の参加者を申請します。承認済みのアンケートがない場合、参加者はアンケートを待機する状態になります(questionnaire_pending)。承認済みのアンケートがある場合はネットワークのオンボーディングに進み(submitted_to_network)、ネットワークからコードが付与されると有効になります。この操作は冪等です。保留中、オンボーディング中、または稼働中の参加者はそのまま返されます。ネットワークが登録を拒否した場合(last_errorが設定されている場合)、再度リクエストすると再試行されます。TRUSTとVerifyVASPには、お客様自身のメンバーシップを通じてのみアクセスできます。TRUSTはVASPごとにメンバーを受け入れ、VerifyVASP
        Enclaveは1つのVASP IDに対応するためです。
      operationId: requestTravelRuleNetworkAccess
      parameters:
        - name: network
          in: path
          required: true
          schema:
            type: string
            enum:
              - gtr
              - sygna
          description: Diditのメンバーシップを通じて参加するネットワークです。
      responses:
        '200':
          description: ネットワーク上のお客様の参加者です。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TravelRuleNetworkParticipant'
        '400':
          description: >-
            不明なネットワーク、Diditが対応していないネットワーク(独自のメンバーシップを接続してください)、またはサンドボックスのアプリケーションです。
          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: APIキーがないか無効です。
        '403':
          description: Diditのメンバーシップを通じたネットワークアクセスは、まだ開放されていません。
          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: 1つのネットワーク上での、このアプリケーション自身の参加者。
      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：一度もリクエストされていない、またはネットワークが最初のリクエストを拒否した（last_errorを参照）。questionnaire_pending：デューデリジェンスのアンケートの承認待ち。submitted_to_network：ネットワークのオンボーディングに引き渡し済み。active：ネットワークがこのアプリケーションに独自の参加者コードを付与した。suspended
            / rejected：Diditが停止または拒否した。
        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: 登録を拒否した際のネットワークの回答です。それ以外の場合は空です。
        history:
          type: array
          readOnly: true
          description: すべてのステータス変更を古い順に示します。
          items:
            type: object
            properties:
              at:
                type: string
                format: date-time
              from:
                type: string
              to:
                type: string
              note:
                type: string
                description: レビューメモ、またはネットワークからの回答（ある場合）。
  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.