API SPEC · V1 · GADEVELOPER REFERENCE

    API per sviluppatori

    API REST per lo screening AML

    Integri sanzioni, PEP, liste di controllo penale, adverse media e screening KYB/UBO direttamente nei Suoi flussi di onboarding, monitoraggio e transazione. L'API è attiva: si autentichi con una API key e chiami lo stesso motore di screening usato dal portale.

    L'API v1 è attiva

    Gli endpoint sono generalmente disponibili con autenticazione tramite API key e rate limit per piano. Esplori ogni endpoint nella documentazione OpenAPI interattiva su /api/v1/docs.

    §01Avvio rapido

    01 / 05
    STEP 01

    1. Crea una API key

    Crei una API key con permessi definiti dalla Sua dashboard, oppure ne generi una a livello di codice con il token bearer del Suo account per le richieste server-to-server.

    curl
    curl -X POST https://screenveritai.com/api/v1/keys \
      -H "Authorization: Bearer <SUPABASE_JWT>" \
      -H "Content-Type: application/json" \
      -d '{"name":"server-key","permissions":["search:read","search:write"]}'
    STEP 02

    2. Esegui la prima ricerca

    Invii un'entità con l'intestazione X-API-Key. L'API restituisce un id di ricerca che recupera al termine dell'elaborazione.

    curl
    curl -X POST https://screenveritai.com/api/v1/search \
      -H "X-API-Key: <YOUR_API_KEY>" \
      -H "Content-Type: application/json" \
      -d '{"entity_name":"Acme Ltd","entity_type":"company","search_type":"full_search"}'
    STEP 03

    3. Invia un batch

    Invii un file CSV/XLSX per sottoporre a screening molte entità in un unico job, poi recuperi le righe o le esportazioni al termine del batch.

    curl
    curl -X POST https://screenveritai.com/api/v1/batch \
      -H "X-API-Key: <YOUR_API_KEY>" \
      -F "file=@entities.csv"

    §02Endpoint principali

    02 / 05
    EP 01ENDPOINT

    POST /api/v1/search

    Crea una richiesta di screening per un'entità. Restituisce un id di ricerca e lo stato di elaborazione. Sono disponibili anche endpoint per account, copertura e stato del servizio sotto /api/v1.

    Auth: X-API-Key (search:write)

    EP 02ENDPOINT

    POST /api/v1/batch

    Invia file CSV/XLSX per screening ad alto volume, poi recupera righe o esportazioni al termine dei job.

    Auth: X-API-Key (batch:write)

    EP 03ENDPOINT

    POST /api/v1/keys

    Crea e gestisce credenziali API con permessi definiti, rate limit differenziati per piano e tracciamento dell'utilizzo.

    Auth: Bearer token (account)

    §03Perché i team usano l'API

    03 / 05
    • Un'unica integrazione per screening di sanzioni, PEP, liste di controllo penale, adverse media e KYB/UBO
    • Autenticazione con API key tramite l'intestazione X-API-Key, con chiavi a permessi definiti per un accesso a privilegio minimo
    • Rate limit per piano con registro degli utilizzi per governance e controllo dei costi
    • Endpoint di ricerca, batch, chiavi, account, copertura e stato del servizio sotto /api/v1
    • Documentazione OpenAPI interattiva su /api/v1/docs più uno schema OpenAPI leggibile da macchina
    • Output strutturato adatto a registri di audit, fascicoli di caso e decisioni a valle

    §05FAQ sull'API

    05 / 05
    Q01

    Come autentico le richieste API?

    Le richieste di screening a /api/v1/search e /api/v1/batch si autenticano con una API key inviata nell'intestazione X-API-Key. Crei le chiavi dalla Sua dashboard, oppure a livello di codice tramite /api/v1/keys dopo essersi autenticato con il token bearer del Suo account.

    Q02

    L'API è generalmente disponibile?

    Sì. L'API v1 è attiva e generalmente disponibile. Si autentichi con una API key, chiami gli endpoint di ricerca, batch e gestione chiavi, ed esplori tutto nella documentazione OpenAPI interattiva su /api/v1/docs.

    Q03

    Posso definire i permessi delle API key?

    Sì. Le chiavi supportano permessi come search:read, search:write, batch:read e batch:write, così può applicare un accesso a privilegio minimo per ogni integrazione.

    Q04

    Quali rate limit si applicano?

    I rate limit sono assegnati per livello API e applicati per ogni API key — il livello regola il throughput delle richieste, non la fatturazione. Le intestazioni di risposta includono il limite, la quota residua e i timestamp di reset, così può gestire correttamente i tentativi.

    Q05

    Dove posso testare rapidamente gli endpoint?

    Utilizzi la documentazione interattiva su /api/v1/docs per test Swagger e /api/v1/redoc per la documentazione in stile riferimento. Lo schema OpenAPI viene servito su /api/v1/openapi.json.