> ## 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 对手方联系人 API - Travel Rule 邮件通道列表

> 列出 Travel Rule 邮件通道可为您的应用发送邮件的合规地址，包括 Didit 平台联系人和您自己的私有联系人。



列出交易对手联系人 API 提示
        将提示词复制到剪贴板



      
      

\<pre>

\`List the compliance addresses Didit's Travel Rule EMAIL rail may write to for my application.

Endpoint:
GET https://verification.didit.me/v3/travel-rule/counterparty-contacts/

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

Query parameters:
\- counterparty (optional) - a directory entry id from GET /v3/travel-rule/vasps/. Must be a UUID; a value that is not one answers 400 {"counterparty": ["Must be a valid UUID."]}. An empty value means no filter.
\- limit (default 50), offset. The list is newest first; count stops at 100, so 100 means 100 or more.

What to read from each contact:
\- scope - platform (curated by Didit, or learned from an address at one of the VASP's own domains that answered; used for every Didit customer, read-only) or application (private to my application).
\- counterparty, counterparty_name, email, name.
\- source - staff (curated by Didit), learned (an address that answered a request through its response link: platform scope when it is at one of the VASP's own domains, otherwise application scope, private to the application whose request it answered) or application (added by my application).
\- verified_at - when the address last answered a request through its response link.
\- is_invalid, invalid_reason (hard_bounce | soft_bounce | spam_complaint | suppressed, empty while valid), invalid_detail, invalid_at - a bounced or complaining address is skipped by the EMAIL rail. A bounce marks only the contact it reached; suppressed marks every contact at an address Didit's email delivery stopped sending to (after a permanent bounce, a spam complaint or an unsubscribe), and those contacts are valid again once sending to the address resumes.
\- created_by - empty on platform contacts and on contacts an API key added.

Add a contact with POST /v3/travel-rule/counterparty-contacts/ and delete one of mine with DELETE /v3/travel-rule/counterparty-contacts/{contact_uuid}/.

Full guide: /transaction-monitoring/travel-rule#contacts.`

\</pre>



      
      

粘贴到



## OpenAPI

````yaml zh/openapi-25.json GET /v3/travel-rule/counterparty-contacts/
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/counterparty-contacts/:
    get:
      tags:
        - Travel Rule
      summary: 列出交易对手联系人
      description: >-
        EMAIL 渠道可为您应用写入的合规地址：Didit 平台联系人加上您应用自身的私有联系人，包括已退信的联系人，按最新优先排序。通过
        `limit`（默认 50）和 `offset` 进行分页；`count` 最大统计到 100，因此 100 表示 100 或更多。
      operationId: listTravelRuleCounterpartyContacts
      parameters:
        - name: counterparty
          in: query
          schema:
            type: string
            format: uuid
          description: 仅该目录条目的联系人。必须是 UUID；空值表示不进行过滤。
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
          description: 页面大小，默认为 50。
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
          description: 要跳过的行。
      responses:
        '200':
          description: 联系人。
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                  next:
                    type: string
                    nullable: true
                  previous:
                    type: string
                    nullable: true
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/TravelRuleCounterpartyContact'
              example:
                count: 1
                next: null
                previous: null
                results:
                  - uuid: 6c1f9b8e-2d4a-4f7e-8b3c-5a9d0e1f2a3b
                    counterparty: 0d6f3c2a-6a1e-4c55-9a39-1f2b0c7d8e91
                    counterparty_name: Example Counterparty VASP
                    email: compliance@counterparty.example
                    name: Compliance desk
                    source: application
                    scope: application
                    created_by: ''
                    verified_at: null
                    is_invalid: false
                    invalid_reason: ''
                    invalid_detail: ''
                    invalid_at: null
                    created_at: '2026-10-19T09:00:00Z'
        '400':
          description: '`counterparty` 不是有效的 UUID。'
          content:
            application/json:
              example:
                counterparty:
                  - Must be a valid UUID.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X GET
            'https://verification.didit.me/v3/travel-rule/counterparty-contacts/?counterparty={vasp_id}'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            for item in client.travel_rule.counterparty_contacts.list():
                print(item)
        - lang: javascript
          label: Node.js
          source: >-
            import Didit from "@didit-protocol/sdk-node";


            // Reads DIDIT_API_KEY.

            const didit = new Didit();


            for await (const item of
            didit.travelRule.counterpartyContacts.list()) {
              console.log(item);
            }
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.TravelRule.CounterpartyContacts.ListAutoPaging(ctx, didit.TravelRuleCounterpartyContactsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}"
        - lang: java
          label: Java
          source: |-
            import me.didit.Didit;

            // Reads DIDIT_API_KEY.
            Didit client = new Didit();

            for (var item : client.travelRule().counterpartyContacts().list()) {
                System.out.println(item);
            }
        - lang: php
          label: PHP
          source: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY.

            $didit = new DiditClient();


            foreach ($didit->travelRule->counterpartyContacts->list() as $item)
            {
                print_r($item->toArray());
            }
        - lang: ruby
          label: Ruby
          source: >-
            require "didit"


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            didit.travel_rule.counterparty_contacts.list.auto_paging_each do
            |item|
              puts item.to_h
            end
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            await foreach (var item in await
            client.TravelRule.CounterpartyContacts.ListAsync())

            {
                Console.WriteLine(JsonSerializer.Serialize(item));
            }
components:
  schemas:
    TravelRuleCounterpartyContact:
      type: object
      description: EMAIL 渠道写入单个名录条目的合规地址。
      properties:
        uuid:
          type: string
          format: uuid
        counterparty:
          type: string
          format: uuid
          description: 目录条目的 `id`，如 GET /v3/travel-rule/vasps/ 所显示。
        counterparty_name:
          type: string
        email:
          type: string
          format: email
        name:
          type: string
          description: 可选标签，例如团队名称。
        source:
          type: string
          enum:
            - staff
            - application
            - learned
          description: >-
            staff：由 Didit 维护。learned：该 VASP
            自身域名下的地址，通过其响应链接回复了请求。application：由您的应用添加。
        scope:
          type: string
          enum:
            - platform
            - application
          description: >-
            platform：由 Didit 整理或从已验证的响应中获取，供所有 Didit
            客户使用，对您而言为只读。application：对您的应用私有。
        created_by:
          type: string
          description: 对于平台联系人和通过 API 密钥添加的联系人，该项为空。
        verified_at:
          type: string
          format: date-time
          nullable: true
          description: 此地址上次通过其响应链接回复请求的时间。
        is_invalid:
          type: boolean
          description: 一旦地址发生退信或投诉，则为 true；EMAIL 通道会跳过该地址。
        invalid_reason:
          type: string
          enum:
            - ''
            - hard_bounce
            - soft_bounce
            - spam_complaint
            - suppressed
        invalid_detail:
          type: string
          description: 接收邮件服务器返回的原因（如有）。
        invalid_at:
          type: string
          format: date-time
          nullable: true
        created_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.