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

# Screening VASP controparte: API per il controllo sanzioni

> Esegui con Didit uno screening facoltativo e a pagamento di sanzioni e notizie negative su un VASP controparte della Travel Rule.



Prompt API per lo screening di un VASP
        Copia il prompt negli appunti



      
      

\<pre>

\`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.`

\</pre>



      
      

Incolla in



## OpenAPI

````yaml it/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 di verifica dell'identità. Autenticati con l'intestazione x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/travel-rule/vasps/{vasp_id}/screening/:
    post:
      tags:
        - Travel Rule
      summary: Esegui lo screening di un VASP
      description: >-
        Esegui lo screening dell'entità della controparte rispetto a sanzioni e
        notizie negative per la tua applicazione. Funzionalità facoltativa:
        counterparty_screening_enabled deve essere attivo nelle tue impostazioni
        di Travel Rule. Ciascun nuovo screening viene fatturato al prezzo di
        Screening AML aziendale della tua organizzazione; in caso contrario,
        viene restituito uno screening risalente a meno di 30 giorni fa (200,
        non fatturato), a meno che non invii refresh: true. Viene eseguito uno
        screening di una controparte alla volta per applicazione. Il risultato è
        privato per la tua applicazione. Le applicazioni sandbox non vengono mai
        sottoposte a screening.
      operationId: screenTravelRuleVasp
      parameters:
        - name: vasp_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: >-
            L'id di una riga di GET /v3/travel-rule/vasps/: una voce della
            directory o un membro della rete Didit.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TravelRuleCounterpartyScreeningRequest'
            example:
              refresh: false
      responses:
        '200':
          description: >-
            Esisteva già uno screening recente che è stato restituito. Nessun
            addebito applicato.
          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: È stato eseguito un nuovo screening ed è stato fatturato.
          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: >-
            Il body non è valido oppure la controparte non ha un nome da
            sottoporre a screening.
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: array
                  items:
                    type: string
              example:
                detail:
                  - This counterparty has no name to screen.
        '403':
          description: >-
            Il saldo della tua organizzazione non è sufficiente a coprire lo
            screening (codice insufficient_credits; nulla è stato eseguito e
            nulla è stato fatturato), oppure il tuo contratto non ha una tariffa
            configurata per questa operazione.
          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: >-
            Nessuna voce della directory o membro elencato della rete Didit ha
            questo id. Il tuo profilo VASP non è mai una tua controparte.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: No directory entry or Didit network member has this id.
        '409':
          description: >-
            Non è stato eseguito nulla e non è stato addebitato alcun importo:
            lo screening della controparte è disattivato per la tua
            applicazione, l'applicazione è in ambiente sandbox oppure è già in
            corso uno screening per questa controparte.
          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: >-
            Non è stato possibile completare lo screening. Non è stato fatturato
            nulla; riprova tra un momento.
          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: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY.

            $didit = new DiditClient();


            $result =
            $didit->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 esegue nuovamente lo screening (e lo fattura nuovamente) anche
            quando esiste uno screening recente.
    TravelRuleCounterpartyScreeningResult:
      type: object
      properties:
        outcome:
          type: string
          enum:
            - screened
            - reused
          description: >-
            screened: è stato eseguito e fatturato un nuovo screening (201).
            reused: è stato restituito uno screening recente e non è stato
            fatturato nulla (200).
        screening:
          $ref: '#/components/schemas/TravelRuleCounterpartyScreening'
    TravelRuleCounterpartyScreening:
      type: object
      description: >-
        Uno screening per sanzioni e notizie negative dell'entità della
        controparte, eseguito e fatturato per la tua applicazione. Riservato
        alla tua applicazione: nessun altro cliente potrà mai vederlo.
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - Approved
            - In Review
            - Declined
          description: >-
            Approvata: nessuna possibile corrispondenza richiede attenzione. In
            revisione o Rifiutata: una possibile corrispondenza con liste di
            sanzioni o notizie negative.
        total_hits:
          type: integer
          description: Quante corrispondenze potenziali ha restituito lo screening.
        score:
          type: number
          nullable: true
          description: >-
            Il punteggio di rischio più elevato tra le possibili corrispondenze.
            Null quando non c'è stata alcuna corrispondenza.
        screened_at:
          type: string
          format: date-time
        fresh:
          type: boolean
          description: >-
            Indica se lo screening è più recente di fresh_days (30 giorni). Uno
            screening recente viene riutilizzato anziché fatturato nuovamente.
        flagged:
          type: boolean
          description: >-
            true mentre lo screening è recente e il suo stato è In Review o
            Declined. Quando l'ultimo screening è segnalato e lo screening della
            controparte rimane attivo, counterparty_risk_level è HIGH nelle tue
            regole.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La chiave API della tua applicazione, da Developers -> API keys nella
        Business Console. La chiave primaria ha accesso completo. Una chiave con
        nome può avere un ambito definito: nessuno, lettura o scrittura per
        risorsa, limitata ad alcuni workflow o a sessioni approvate, a un elenco
        di indirizzi IP e a una data di scadenza. 401 indica che la chiave è
        errata, revocata o scaduta; 403 indica che non è stata inviata alcuna
        chiave, che la chiave non ha accesso a questa risorsa o azione, oppure
        che la richiesta proviene da un indirizzo non incluso nel suo elenco IP;
        404 su una route di sessione indica che la sessione non rientra nei
        workflow o negli stati previsti dalla chiave. Una chiave senza accesso
        ai media riceve gli URL di immagini, video e PDF come null, e una chiave
        senza permessi di scrittura sulle sessioni riceve link e token di
        sessione come null. Consulta https://docs.didit.me/console/api-keys.

````

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