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

# 获取交易对手 VASP 筛查 API：Travel Rule

> Didit 可查询交易对手筛查是否开启、单次筛查费用，以及您对交易对手 VASP 的最新制裁筛查结果。

获取 VASP 筛查 API 提示词
将提示词复制到剪贴板

<pre>
  \`Read my application's sanctions and adverse-media screening of a Travel Rule counterparty VASP, and whether I can run one.

  Endpoint:
  GET [https://verification.didit.me/v3/travel-rule/vasps/\{vasp\_id}/screening/](https://verification.didit.me/v3/travel-rule/vasps/\{vasp_id}/screening/)

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

  vasp\_id is the id GET /v3/travel-rule/vasps/ returns for a directory entry or a Didit network member.

  What to read from the response:

  * enabled - my counterparty\_screening\_enabled Travel Rule setting. Off by default: nothing is screened or billed while it is off.
  * price - decimal string in USD: what one screening costs my organization (the Company AML Screening price).
  * fresh\_days - how long a screening stays fresh and is reused instead of billed again (30).
  * screening - null when I never screened this counterparty; otherwise {id, status, total_hits, score, screened_at, fresh, flagged}.
  * screening.status - Approved (no possible match needs attention), In Review or Declined (a possible sanctions or adverse-media match).
  * screening.flagged - true while the screening is fresh and In Review or Declined. While my latest screening is flagged and screening stays on, my rules read counterparty\_risk\_level as HIGH for this counterparty.

  The screening is private to my application: no other Didit customer sees it, and it never changes the shared directory entry.

  Failure modes:

  * 403 - my organization's contract has no rate configured for counterparty screening.
  * 404 - no directory entry or listed Didit network member has this id, or the id is my own VASP profile.

  Full guide: /transaction-monitoring/travel-rule#counterparty-screening.\`
</pre>

粘贴到


## OpenAPI

````yaml zh/openapi-25.json GET /v3/travel-rule/vasps/{vasp_id}/screening/
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/vasps/{vasp_id}/screening/:
    get:
      tags:
        - Travel Rule
      summary: 获取 VASP 实体筛查结果
      description: 您的应用是否启用了交易对手筛查、单次筛查对您组织的费用、结果的有效保留时长，以及您对该交易对手最近一次的制裁和负面新闻筛查记录。读取此信息免费。
      operationId: getTravelRuleVaspScreening
      parameters:
        - name: vasp_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: GET /v3/travel-rule/vasps/ 中某一行记录的 id：目录条目或 Didit 网络成员。
      responses:
        '200':
          description: 您的筛查设置、其价格以及您最新的筛查。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TravelRuleCounterpartyScreeningStatus'
              example:
                enabled: true
                price: '0.20'
                fresh_days: 30
                screening:
                  id: 7a1d2c3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d
                  status: Approved
                  total_hits: 0
                  score: null
                  screened_at: '2026-10-14T09:58:00Z'
                  fresh: true
                  flagged: false
        '403':
          description: 您组织的合同未配置交易对手筛查的费率。
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: No contract rate is configured for this usage type.
        '404':
          description: 目录中没有具有此 id 的条目或已列出的 Didit 网络成员。您自己的 VASP 资料绝不会是您的交易对手。
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: No directory entry or Didit network member has this id.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X GET
            https://verification.didit.me/v3/travel-rule/vasps/{vasp_id}/screening/
            \
              -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.retrieve_vasp_screening(
                "11111111-2222-3333-4444-555555555555",
            )
            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.retrieveVaspScreening("11111111-2222-3333-4444-555555555555");

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.RetrieveVASPScreening(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.travelRule().retrieveVaspScreening("11111111-2222-3333-4444-555555555555");

            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->retrieveVaspScreening('11111111-2222-3333-4444-555555555555');

            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: >-
            require "didit"


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            result =
            didit.travel_rule.retrieve_vasp_screening("11111111-2222-3333-4444-555555555555")

            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.RetrieveVaspScreeningAsync("11111111-2222-3333-4444-555555555555");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    TravelRuleCounterpartyScreeningStatus:
      type: object
      properties:
        enabled:
          type: boolean
          description: >-
            您的 counterparty_screening_enabled Travel Rule
            设置。默认关闭；处于关闭状态时不会进行任何筛查或计费。
        price:
          type: string
          description: 十进制字符串，以 USD 计：贵组织单次筛查的费用，即企业 AML 筛查价格。
        fresh_days:
          type: integer
          description: 筛查结果保持有效并被复用的天数。
        screening:
          allOf:
            - $ref: '#/components/schemas/TravelRuleCounterpartyScreening'
          nullable: true
          description: 您对该交易对手的最新筛查。如果您从未筛查过，则为 null。
    TravelRuleCounterpartyScreening:
      type: object
      description: 针对交易对手实体进行的一次制裁和负面新闻筛查，为您的应用运行并向您的应用计费。仅对您的应用可见：其他客户绝不可见。
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - Approved
            - In Review
            - Declined
          description: 已通过：无需要注意的可能匹配项。审核中或已拒绝：存在可能的制裁或负面新闻匹配项。
        total_hits:
          type: integer
          description: 筛查返回的可能匹配项数量。
        score:
          type: number
          nullable: true
          description: 可能匹配项中的最高风险评分。未匹配到任何内容时为 Null。
        screened_at:
          type: string
          format: date-time
        fresh:
          type: boolean
          description: 筛查时间是否短于 fresh_days（30 天）。处于有效期内的筛查会被复用，而不会再次计费。
        flagged:
          type: boolean
          description: >-
            当筛查是最新的且其状态为 In Review 或 Declined 时为
            true。当您最新的筛查被标记且交易对手筛查保持开启时，在您的规则中 counterparty_risk_level 为 HIGH。
  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.