> ## 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 de filtrage d'un VASP contrepartie : sanctions > Filtrage sanctions et presse négative d'un VASP contrepartie Travel Rule, sur option et facturé, via l'API Didit pour votre application. Prompt pour filtrer un VASP via l'API Copier le prompt dans le presse-papiers \

\`Screen a Travel Rule counterparty VASP against sanctions and adverse media for my application.

Endpoint:
POST https://verification.didit.me/v3/travel-rule/vasps/{vasp_id}/screening/

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

Prerequisite:
Turn on counterparty screening first: PUT /v3/travel-rule/settings/ with {"counterparty_screening_enabled": true}. It is off by default.

Example call:
curl -X POST "https://verification.didit.me/v3/travel-rule/vasps/{vasp_id}/screening/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"refresh": false}'

Body (optional):
\- refresh - true screens again even when a fresh screening exists. Default false.

What happens:
\- 201 {"outcome": "screened", "screening": {...}} - a new screening ran and was billed at my organization's Company AML Screening price (GET .../screening/ returns the price).
\- 200 {"outcome": "reused", "screening": {...}} - a screening younger than 30 days already existed and was returned. Nothing was billed.
\- screening is {id, status, total_hits, score, screened_at, fresh, flagged}. status is Approved, In Review or Declined; flagged is true while a fresh screening is 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 shared risk_level in the directory does not change.
\- The screening is private to my application: no other Didit customer sees it.
\- With screening on, Didit also screens the counterparty an outbound Travel Rule exchange reaches when the exchange starts, reusing a fresh screening and billing a new one the same way. A refusal or failure there never fails the transfer.

Failure modes (nothing runs and nothing is billed):
\- 400 - the counterparty has no name to screen, or the body is not valid.
\- 403 - my organization's balance cannot cover the screening (code insufficient_credits), or my contract has no rate configured for it.
\- 404 - no directory entry or listed Didit network member has this id, or the id is my own VASP profile.
\- 409 - counterparty screening is off, the application is a sandbox one, or a screening of this counterparty is already running.
\- 502 - the screening could not be completed; try again in a moment.

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

\
Coller dans ## OpenAPI ````yaml fr/openapi-25.json POST /v3/travel-rule/vasps/{vasp_id}/screening/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API de vérification d'identité. Authentifiez-vous avec l'en-tête x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/travel-rule/vasps/{vasp_id}/screening/: post: tags: - Travel Rule summary: Filtrer un VASP description: >- Filtrez l'entité contrepartie par rapport aux sanctions et à la presse négative pour votre application. Activation préalable : counterparty_screening_enabled doit être activé dans vos paramètres Travel Rule. Chaque nouveau filtrage est facturé au tarif de filtrage AML d'entreprise de votre organisation ; un filtrage de moins de 30 jours est renvoyé à la place (200, non facturé), sauf si vous envoyez refresh: true. Un seul filtrage d'une contrepartie s'exécute à la fois par application. Le résultat est privé et accessible uniquement à votre application. Les applications sandbox ne font jamais l'objet d'un filtrage. operationId: screenTravelRuleVasp parameters: - name: vasp_id in: path required: true schema: type: string format: uuid description: >- L'identifiant d'une ligne de GET /v3/travel-rule/vasps/ : une entrée de l'annuaire ou un membre du réseau Didit. requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/TravelRuleCounterpartyScreeningRequest' example: refresh: false responses: '200': description: >- Un filtrage récent existait déjà et a été renvoyé. Rien n'a été facturé. content: application/json: schema: $ref: '#/components/schemas/TravelRuleCounterpartyScreeningResult' example: outcome: reused 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 '201': description: Un nouveau filtrage a été exécuté et facturé. content: application/json: schema: $ref: '#/components/schemas/TravelRuleCounterpartyScreeningResult' example: outcome: screened screening: id: 7a1d2c3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d status: In Review total_hits: 2 score: 85 screened_at: '2026-10-14T09:58:00Z' fresh: true flagged: true '400': description: >- Le corps n'est pas valide, ou la contrepartie n'a aucun nom à filtrer. content: application/json: schema: type: object additionalProperties: type: array items: type: string example: detail: - This counterparty has no name to screen. '403': description: >- Le solde de votre organisation ne peut pas couvrir le filtrage (code insufficient_credits ; rien n'a été exécuté ni facturé), ou votre contrat ne comporte aucun tarif configuré pour celui-ci. content: application/json: schema: type: object properties: detail: type: string code: type: string example: detail: >- You don't have enough credits to perform this request. Please top up at https://business.didit.me code: insufficient_credits '404': description: >- Aucune entrée d'annuaire ou aucun membre répertorié du réseau Didit ne possède cet identifiant. Votre propre profil VASP n'est jamais une contrepartie pour vous. content: application/json: schema: type: object properties: detail: type: string example: detail: No directory entry or Didit network member has this id. '409': description: >- Rien n'a été exécuté et rien n'a été facturé : le filtrage des contreparties est désactivé pour votre application, l'application est en sandbox, ou un filtrage de cette contrepartie est déjà en cours d'exécution. content: application/json: schema: type: object properties: detail: type: string examples: Screening off: value: detail: >- Counterparty screening is turned off. Enable it in the Travel Rule settings first. Sandbox application: value: detail: >- Counterparty screening does not run for sandbox applications. Already running: value: detail: >- A screening of this counterparty is already running. Try again in a moment. '502': description: >- Le filtrage n'a pas pu être effectué. Rien n'a été facturé ; réessayez dans un instant. content: application/json: schema: type: object properties: detail: type: string example: detail: The screening provider did not answer. Try again in a moment. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: >- curl -X POST https://verification.didit.me/v3/travel-rule/vasps/{vasp_id}/screening/ \ -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \ -d '{"refresh": false}' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.travel_rule.screen_vasp( "11111111-2222-3333-4444-555555555555", refresh=False, ) 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.screenVasp("11111111-2222-3333-4444-555555555555", { refresh: false, }); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.ScreenVASP(ctx, \"11111111-2222-3333-4444-555555555555\", didit.TravelRuleCounterpartyScreeningRequest{\n\tRefresh: didit.Bool(false),\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.TravelRuleCounterpartyScreeningRequest; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.travelRule().screenVasp("11111111-2222-3333-4444-555555555555", TravelRuleCounterpartyScreeningRequest.builder() .refresh(false) .build()); System.out.println(result); - lang: php label: PHP source: >- travelRule->screenVasp('11111111-2222-3333-4444-555555555555', [ 'refresh' => false, ]); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.travel_rule.screen_vasp( "11111111-2222-3333-4444-555555555555", refresh: false ) 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.ScreenVaspAsync("11111111-2222-3333-4444-555555555555", new TravelRuleCounterpartyScreeningRequest { Refresh = false, }); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: TravelRuleCounterpartyScreeningRequest: type: object properties: refresh: type: boolean default: false description: >- true filtre à nouveau (et facture à nouveau) même lorsqu'un filtrage récent existe. TravelRuleCounterpartyScreeningResult: type: object properties: outcome: type: string enum: - screened - reused description: >- screened : un nouveau filtrage a été exécuté et facturé (201). reused : un filtrage récent a été renvoyé et rien n'a été facturé (200). screening: $ref: '#/components/schemas/TravelRuleCounterpartyScreening' TravelRuleCounterpartyScreening: type: object description: >- Un filtrage des sanctions et de la presse négative de l'entité contrepartie, exécuté pour votre application et facturé à celle-ci. Réservé à votre application : un autre client ne le verra jamais. properties: id: type: string format: uuid status: type: string enum: - Approved - In Review - Declined description: >- Approuvé : aucune correspondance possible ne nécessite d'attention. En cours d'examen ou refusé : une correspondance possible avec des sanctions ou de la presse négative. total_hits: type: integer description: Nombre de correspondances possibles renvoyées par le filtrage. score: type: number nullable: true description: >- Le score de risque le plus élevé parmi les correspondances possibles. Null si rien ne correspondait. screened_at: type: string format: date-time fresh: type: boolean description: >- Indique si le filtrage est plus récent que fresh_days (30 jours). Un filtrage récent est réutilisé au lieu d'être à nouveau facturé. flagged: type: boolean description: >- true tant que le filtrage est récent et que son statut est In Review ou Declined. Tant que votre dernier filtrage est signalé et que le filtrage de la contrepartie reste activé, counterparty_risk_level est HIGH dans vos règles. securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- La clé API de votre application, issue de Développeurs -> Clés API dans la Business Console. La clé principale dispose d'un accès complet. Une clé nommée peut être restreinte : aucun, lecture ou écriture par ressource, limitée à certains workflows ou aux sessions approuvées, à une liste d'adresses IP et à une date d'expiration. 401 signifie que la clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a été envoyée, que la clé n'a pas accès à cette ressource ou action, ou que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur une route de session signifie que la session est hors des workflows ou des statuts de la clé. Une clé sans accès aux médias reçoit les URL d'images, de vidéos et de PDF à null, et une clé sans accès en écriture aux sessions reçoit les liens et tokens de session à null. Voir https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.