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

# Gegenpartei-VASP-Screening abrufen: Travel Rule API

> Didit: Status des Gegenpartei-Screenings, Preis pro Screening und letztes Sanktionsscreening einer Gegenpartei-VASP abrufen.

Prompt für die VASP-Screening-API abrufen
Prompt in die Zwischenablage kopieren

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

Einfügen in


## OpenAPI

````yaml de/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 für Ausweisverifizierung. Authentifizierung über den x-api-key-Header.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/travel-rule/vasps/{vasp_id}/screening/:
    get:
      tags:
        - Travel Rule
      summary: Entitätsprüfung eines VASPs abrufen
      description: >-
        Gibt an, ob das Screening von Gegenparteien für Ihre Anwendung aktiviert
        ist, was ein Screening Ihre Organisation kostet, wie lange ein Ergebnis
        aktuell bleibt, sowie Ihr letztes Screening der Gegenpartei auf
        Sanktionen und negative Medienberichte. Das Abrufen ist kostenlos.
      operationId: getTravelRuleVaspScreening
      parameters:
        - name: vasp_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: >-
            Die ID einer Zeile aus der Antwort von GET /v3/travel-rule/vasps/:
            ein Verzeichniseintrag oder ein Mitglied des Didit-Netzwerks.
      responses:
        '200':
          description: >-
            Ihre Screening-Einstellung, deren Preis und Ihr aktuellstes
            Screening.
          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: >-
            Im Vertrag Ihrer Organisation ist kein Tarif für das Screening von
            Gegenparteien konfiguriert.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: No contract rate is configured for this usage type.
        '404':
          description: >-
            Kein Verzeichniseintrag und kein gelistetes Didit-Netzwerkmitglied
            besitzt diese ID. Ihr eigenes VASP-Profil ist niemals eine
            Gegenpartei von Ihnen.
          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: >-
            Ihre Travel-Rule-Einstellung counterparty_screening_enabled.
            Standardmäßig deaktiviert; solange sie deaktiviert ist, wird nichts
            überprüft oder abgerechnet.
        price:
          type: string
          description: >-
            Dezimal-Zeichenkette in USD: Kosten eines Screenings für Ihre
            Organisation, der Preis für das Unternehmens-AML-Screening.
        fresh_days:
          type: integer
          description: >-
            Wie viele Tage ein Screening aktuell bleibt und wiederverwendet
            wird.
        screening:
          allOf:
            - $ref: '#/components/schemas/TravelRuleCounterpartyScreening'
          nullable: true
          description: >-
            Ihr aktuellstes Screening der Gegenpartei. Null, wenn Sie es noch
            nie geprüft haben.
    TravelRuleCounterpartyScreening:
      type: object
      description: >-
        Ein Screening auf Sanktionen und negative Medienberichte der
        Gegenpartei-Entität, für Ihre Anwendung durchgeführt und ihr in Rechnung
        gestellt. Nur für Ihre Anwendung sichtbar: Ein anderer Kunde sieht dies
        niemals.
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - Approved
            - In Review
            - Declined
          description: >-
            Genehmigt: Kein möglicher Treffer erfordert Aufmerksamkeit. In
            Prüfung oder Abgelehnt: Ein möglicher Treffer bei Sanktionen oder
            negativen Medienberichten.
        total_hits:
          type: integer
          description: Wie viele mögliche Treffer das Screening zurückgegeben hat.
        score:
          type: number
          nullable: true
          description: >-
            Der höchste Risiko-Score unter den möglichen Übereinstimmungen.
            Null, wenn nichts übereinstimmte.
        screened_at:
          type: string
          format: date-time
        fresh:
          type: boolean
          description: >-
            Gibt an, ob das Screening neuer als fresh_days (30 Tage) ist. Ein
            frisches Screening wird wiederverwendet, anstatt erneut abgerechnet
            zu werden.
        flagged:
          type: boolean
          description: >-
            true, solange das Screening aktuell ist und sein Status In Review
            oder Declined lautet. Solange Ihr neuestes Screening markiert ist
            und das Gegenpartei-Screening aktiv bleibt, ist
            counterparty_risk_level in Ihren Regeln HIGH.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Der API-Schlüssel Ihrer Anwendung, aus Entwickler -> API-Schlüssel in
        der Business Console. Der Primärschlüssel hat Vollzugriff. Ein benannter
        Schlüssel kann im Geltungsbereich eingeschränkt werden: keine, Lese-
        oder Schreibberechtigung pro Ressource, beschränkt auf bestimmte
        Workflows oder genehmigte Sitzungen, auf eine Liste von IP-Adressen und
        auf ein Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen
        oder abgelaufen ist; 403 bedeutet, dass kein Schlüssel gesendet wurde,
        der Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder
        die Anfrage von einer Adresse außerhalb seiner IP-Liste stammte; 404 bei
        einer Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows
        oder Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff
        erhält Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne
        Schreibberechtigung für Sitzungen erhält Sitzungslinks und Token als
        null. Siehe https://docs.didit.me/console/api-keys.

````

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