> ## 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 创建钱包所有权组件会话：客户可借助消息签名、Satoshi 测试、截图或自我声明证明其对加密钱包的控制权。



生成钱包所有权 Widget 会话 API 提示词
        将提示词复制到剪贴板



      
      

\<pre>

\`Mint a hosted wallet-ownership widget session so a customer can prove control of a crypto wallet - to advance a Travel Rule transfer out of UNCONFIRMED_OWNERSHIP, or to pre-verify a wallet before any transfer exists.

Endpoint:
POST https://verification.didit.me/v3/travel-rule/widget-session/

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

You rarely need this call: with auto_wallet_verification on (the default), Didit auto-mints a widget session at transaction creation whenever a transfer needs end-user proof, and returns it in the transaction's action_required block. Mint manually for pre-verification or when auto_wallet_verification is off.

Request body (application/json):
\{
"wallet_address": "0x8ba1f109551bD432803012645Ac136ddd64DBA72",   // the wallet to verify
"chain": "ETH",                               // chain identifier (ETH, BTC, SOL, TRX, ...); use the same token your transfers carry
"holder_name": "Ana Diaz",                    // used for the beneficiary name match
"vendor_data": "user-042",                    // your internal id, carried onto the address-book entry
"transaction_id": "<didit-transaction-uuid>", // optional: transfer to advance when the proof verifies
"satoshi_deposit_address": "",                // optional: a deposit address you control - enables the SATOSHI_TEST method
"callback_url": "https://yourapp.example/wallet-verified",  // optional: where the widget returns the customer
"expires_in_minutes": 60                      // optional; auto-extended to cover the Satoshi test window
}

When the customer starts a proof, Didit saves the wallet to your address book with this chain (or reuses the entry with the same address and chain).
Address-book matching is chain-scoped and does not translate names ("ethereum" does not match "ETH"), so pass the same chain token your transfers carry.

What to read from the response:
\- url - send your customer there, verbatim (never construct it yourself). Open it in a real browser or the SDK modal - NEVER an embedded mobile webview (wallet deep links cannot escape a webview).
\- widget_session_id, token, expires_at.

Proof methods offered (depending on settings and mint parameters):
\- MESSAGE_SIGNING - when chain is an EVM, Solana, Bitcoin or Tron chain.
Signing works with wallets installed in the customer's browser, discovered in the page (EIP-6963 / Wallet Standard).
Pairing a mobile wallet app (for example by scanning a QR code) is not available in production today.
\- SATOSHI_TEST - a micro-deposit, offered when you pass satoshi_deposit_address and chain is an EVM, Solana or Bitcoin chain.
\- SCREENSHOT - if allow_screenshot_proof.
\- SELF_DECLARATION - if allow_self_declaration.

Detect completion:
\- Poll GET /v3/travel-rule/widget/{token}/ (completed_at becomes non-null), or
\- Subscribe to travel_rule.status.updated webhooks when the session is linked to a transfer.

Failure modes:
\- 400 - callback_url is not an absolute http(s) URL ({"callback_url": ["callback_url must be an absolute http(s) URL."]}), expires_in_minutes is outside 5 to 10080, transaction_id is not a UUID, or a field is longer than its limit.
\- 404 - transaction_id does not name a Travel Rule transfer in this application.
\- Minting does not check wallet_address against the linked transfer, but every proof on a linked session must use the transfer's counterparty wallet, otherwise starting the proof returns 400.

Full guide: /transaction-monitoring/wallet-ownership-widget.`

\</pre>



      
      

粘贴到



## OpenAPI

````yaml zh/openapi-25.json POST /v3/travel-rule/widget-session/
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/widget-session/:
    post:
      tags:
        - Travel Rule
      summary: 生成钱包所有权小部件会话
      description: >-
        生成托管的钱包所有权小组件 URL/token。引导客户访问返回的 URL
        以证明其对钱包的控制权（消息签名、中本聪测试、屏幕截图或自主声明）。此版本中的小组件仅限网页端：请在系统浏览器或自定义标签页中打开该
        URL，切勿在移动 SDK 的 webview 内打开。
      operationId: createTravelRuleWidgetSession
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TravelRuleWidgetSessionCreate'
            example:
              wallet_address: '0xd3b62acb76fb27a7f8961ec40fa11746b113aca9'
              chain: ETH
              holder_name: Jane Doe
              vendor_data: user-042
              transaction_id: 99999999-aaaa-bbbb-cccc-dddddddddddd
              expires_in_minutes: 60
      responses:
        '201':
          description: 已签发的小部件会话。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TravelRuleWidgetSessionResponse'
        '400':
          description: >-
            无效的请求体：`callback_url` 不是绝对 http(s) URL、`expires_in_minutes` 不在 5 到
            10080 之间、`transaction_id` 不是 UUID，或某个字段超出了限制长度。
          content:
            application/json:
              examples:
                Invalid callback_url:
                  value:
                    callback_url:
                      - callback_url must be an absolute http(s) URL.
        '404':
          description: '`transaction_id` 未在此应用中指定 Travel Rule 转账。'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X POST
            https://verification.didit.me/v3/travel-rule/widget-session/ \
              -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \
              -d '{"wallet_address":"0xd3b62acb76fb27a7f8961ec40fa11746b113aca9","chain":"ETH","holder_name":"Jane Doe","transaction_id":"99999999-aaaa-bbbb-cccc-dddddddddddd"}'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.travel_rule.create_widget_session(
                wallet_address="0xd3b62acb76fb27a7f8961ec40fa11746b113aca9",
                chain="ETH",
                holder_name="Jane Doe",
                vendor_data="user-042",
                transaction_id="99999999-aaaa-bbbb-cccc-dddddddddddd",
                expires_in_minutes=60,
            )
            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.createWidgetSession({
              wallet_address: "0xd3b62acb76fb27a7f8961ec40fa11746b113aca9",
              chain: "ETH",
              holder_name: "Jane Doe",
              vendor_data: "user-042",
              transaction_id: "99999999-aaaa-bbbb-cccc-dddddddddddd",
              expires_in_minutes: 60,
            });
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.CreateWidgetSession(ctx, didit.TravelRuleWidgetSessionCreate{\n\tWalletAddress:    didit.String(\"0xd3b62acb76fb27a7f8961ec40fa11746b113aca9\"),\n\tChain:            didit.String(\"ETH\"),\n\tHolderName:       didit.String(\"Jane Doe\"),\n\tVendorData:       didit.String(\"user-042\"),\n\tTransactionID:    didit.String(\"99999999-aaaa-bbbb-cccc-dddddddddddd\"),\n\tExpiresInMinutes: didit.Int(60),\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.TravelRuleWidgetSessionCreate;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.travelRule().createWidgetSession(TravelRuleWidgetSessionCreate.builder()
                    .walletAddress("0xd3b62acb76fb27a7f8961ec40fa11746b113aca9")
                    .chain("ETH")
                    .holderName("Jane Doe")
                    .vendorData("user-042")
                    .transactionId("99999999-aaaa-bbbb-cccc-dddddddddddd")
                    .expiresInMinutes(60L)
                    .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->travelRule->createWidgetSession([
                'wallet_address' => '0xd3b62acb76fb27a7f8961ec40fa11746b113aca9',
                'chain' => 'ETH',
                'holder_name' => 'Jane Doe',
                'vendor_data' => 'user-042',
                'transaction_id' => '99999999-aaaa-bbbb-cccc-dddddddddddd',
                'expires_in_minutes' => 60,
            ]);
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

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

            result = didit.travel_rule.create_widget_session(
              wallet_address: "0xd3b62acb76fb27a7f8961ec40fa11746b113aca9",
              chain: "ETH",
              holder_name: "Jane Doe",
              vendor_data: "user-042",
              transaction_id: "99999999-aaaa-bbbb-cccc-dddddddddddd",
              expires_in_minutes: 60
            )
            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.CreateWidgetSessionAsync(new
            TravelRuleWidgetSessionCreate

            {
                WalletAddress = "0xd3b62acb76fb27a7f8961ec40fa11746b113aca9",
                Chain = "ETH",
                HolderName = "Jane Doe",
                VendorData = "user-042",
                TransactionId = "99999999-aaaa-bbbb-cccc-dddddddddddd",
                ExpiresInMinutes = 60,
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    TravelRuleWidgetSessionCreate:
      type: object
      properties:
        wallet_address:
          type: string
          description: 待验证的钱包地址。可选；留空时，必须在启动证明时提供该地址。
          maxLength: 128
        chain:
          type: string
          description: >-
            地址的链 token，例如 `ETH`、`BTC` 或 `SOL`。请使用与您的钱包地址簿中相同的
            token。消息签名和中本聪测试（Satoshi
            test）仅对受支持的链提供。证明所验证的地址簿条目将其存储在其规范标识符（ETH、BTC、SOL、TRX）下。
          maxLength: 32
        holder_name:
          type: string
          description: 钱包持有者姓名，用于收款人姓名比对。
          maxLength: 255
        vendor_data:
          type: string
          description: 您为持有者指定的内部标识符，将带入所创建的地址簿条目中。
          maxLength: 255
        transaction_id:
          type: string
          format: uuid
          description: 可选。当证明核验通过时需要推进的 Travel Rule 转账的 Didit 交易 UUID。
          nullable: true
        satoshi_deposit_address:
          type: string
          description: 可选。您控制的充值地址；提供该地址可启用 SATOSHI_TEST 证明方式。
          maxLength: 128
        callback_url:
          type: string
          description: 可选。微件在完成后将客户重定向回的绝对 http(s) URL。
          maxLength: 512
        expires_in_minutes:
          type: integer
          description: 可选。生成的链接的有效期（以分钟为单位）。当提供 SATOSHI_TEST 时，会自动延长以覆盖 Satoshi test 时间窗口。
          default: 60
          minimum: 5
          maximum: 10080
    TravelRuleWidgetSessionResponse:
      type: object
      properties:
        widget_session_id:
          type: string
          format: uuid
        token:
          type: string
          description: 嵌入在 widget URL 中的不透明会话 token。
        url:
          type: string
          description: 托管的钱包所有权小部件 URL。请在系统浏览器中原样打开（切勿在移动端 SDK 的 webview 内打开）。
        expires_at:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        您的应用 API 密钥，可在 Business Console 的“开发者 -> API
        密钥”中获取。主密钥拥有完整访问权限。指定名称的密钥可设置作用域：针对每个资源设为无权限、只读或读写，限定于特定工作流或已通过的会话、限定于
        IP 地址列表，以及设置到期日期。401 表示密钥错误、已撤销或已过期；403 表示未发送密钥、密钥无权访问该资源或操作，或请求来自其 IP
        列表之外的地址；在会话路由上返回 404 表示该会话不在该密钥允许的工作流或状态范围内。没有媒体访问权限的密钥获取到的图片、视频和 PDF
        URL 将为 null；没有会话写入权限的密钥获取到的会话链接和 token 将为 null。请参阅
        https://docs.didit.me/console/api-keys。

````

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