> ## 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 hi/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: >-
            किसी भी डायरेक्टरी प्रविष्टि या सूचीबद्ध Didit नेटवर्क सदस्य की यह
            id नहीं है। आपकी अपनी 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: >-
            true जब तक स्क्रीनिंग ताज़ा है और इसकी status In Review या Declined
            है। जब तक आपकी नवीनतम स्क्रीनिंग फ़्लैग की गई है और प्रतिपक्ष
            स्क्रीनिंग चालू रहती है, तब तक आपके नियमों में
            counterparty_risk_level HIGH रहता है।
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        आपकी एप्लिकेशन की API कुंजी, Business Console में Developers -> API keys
        से। प्राथमिक कुंजी के पास पूर्ण एक्सेस होता है। एक नामित कुंजी को स्कोप
        किया जा सकता है: प्रति संसाधन none, read या write, कुछ वर्कफ़्लो या
        स्वीकृत सत्रों तक सीमित, IP पतों की सूची तक सीमित, और समाप्ति तिथि तक
        सीमित। 401 का अर्थ है कि कुंजी गलत है, निरस्त कर दी गई है या उसकी
        समय-सीमा समाप्त हो गई है; 403 का अर्थ है कि कोई कुंजी नहीं भेजी गई थी,
        कुंजी के पास इस संसाधन या कार्रवाई का एक्सेस नहीं है, या अनुरोध उसकी IP
        सूची से बाहर के पते से आया था; सत्र रूट पर 404 का अर्थ है कि सत्र कुंजी
        के वर्कफ़्लो या स्थितियों से बाहर है। मीडिया एक्सेस के बिना एक कुंजी को
        छवि, वीडियो और PDF URL null के रूप में प्राप्त होते हैं, और सत्र write
        के बिना एक कुंजी को सत्र लिंक और token null के रूप में प्राप्त होते हैं।
        देखें https://docs.didit.me/console/api-keys।

````

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