API SPEC · V1 · GADEVELOPER REFERENCE

    Kehittäjä-API

    REST API AML-seulontaan

    Integroi pakote-, PEP-, rikollisuuden tarkkailulistojen, kielteisen julkisuuden ja KYB/UBO-seulonta suoraan liittymis-, seuranta- ja transaktiovirtoihisi. API on toiminnassa: todennat API-avaimella ja kutsut samaa seulontamoottoria, jota portaali käyttää.

    API v1 on toiminnassa

    Päätepisteet ovat yleisesti saatavilla API-avaintodennuksella ja tasokohtaisilla käyttörajoilla. Tutustu jokaiseen päätepisteeseen interaktiivisessa OpenAPI-dokumentaatiossa osoitteessa /api/v1/docs.

    §01Pika-aloitus

    01 / 05
    STEP 01

    1. Luo API-avain

    Luo rajattu API-avain hallintapaneelistasi, tai luo sellainen ohjelmallisesti tilisi bearer-tokenilla palvelimelta palvelimelle -pyyntöjä varten.

    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. Suorita ensimmäinen haku

    Lähetä toimija X-API-Key-otsikolla. API palauttaa haun tunnisteen, jonka noudat käsittelyn valmistuttua.

    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. Lähetä erä

    Lähetä CSV/XLSX-tiedosto seuloaksesi monta toimijaa yhdessä työssä, ja nouda sitten rivit tai viennit erän valmistuttua.

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

    §02Keskeiset päätepisteet

    02 / 05
    EP 01ENDPOINT

    POST /api/v1/search

    Luo seulontapyynnön yhdelle toimijalle. Palauttaa haun tunnisteen ja käsittelytilan. Myös tili-, kattavuus- ja tilapäätepisteet ovat saatavilla /api/v1-osoitteessa.

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

    EP 02ENDPOINT

    POST /api/v1/batch

    Lähetä CSV/XLSX-tiedostoja suurivolyymiseen seulontaan, ja nouda sitten rivit tai viennit työn valmistuttua.

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

    EP 03ENDPOINT

    POST /api/v1/keys

    Luo ja hallitse API-tunnuksia rajatuin oikeuksin, tasotietoisin käyttörajoin ja käytön seurannalla.

    Todennus: Bearer-token (tili)

    §03Miksi tiimit käyttävät API:a

    03 / 05
    • Yksi integraatio pakote-, PEP-, rikollisuuden tarkkailulistojen, kielteisen julkisuuden ja KYB/UBO-seulontaan
    • API-avaintodennus X-API-Key-otsikon kautta, oikeusrajatuin avaimin vähimmäisoikeuksien käyttöoikeuksia varten
    • Tasokohtaiset käyttörajat käyttölokituksella hallintaa ja kustannusten valvontaa varten
    • Haku-, erä-, avain-, tili-, kattavuus- ja tilapäätepisteet osoitteessa /api/v1
    • Interaktiivinen OpenAPI-dokumentaatio osoitteessa /api/v1/docs sekä koneluettava OpenAPI-skeema
    • Strukturoitu tuloste, joka sopii auditointilokeihin, tapaustiedostoihin ja jatkopäätöksiin

    §05API:n UKK

    05 / 05
    Q01

    Miten API-pyynnöt todennetaan?

    Seulontapyynnöt osoitteisiin /api/v1/search ja /api/v1/batch todennetaan API-avaimella, joka lähetetään X-API-Key-otsikossa. Luo avaimet hallintapaneelistasi tai ohjelmallisesti /api/v1/keys-osoitteen kautta tilisi bearer-tokenilla todennuksen jälkeen.

    Q02

    Onko API yleisesti saatavilla?

    Kyllä. API v1 on toiminnassa ja yleisesti saatavilla. Todennat API-avaimella, kutsut haku-, erä- ja avainhallintapäätepisteitä ja tutustut kaikkeen interaktiivisessa OpenAPI-dokumentaatiossa osoitteessa /api/v1/docs.

    Q03

    Voinko rajata API-avaimen oikeuksia?

    Kyllä. Avaimet tukevat oikeuksia kuten search:read, search:write, batch:read ja batch:write, joten voit toteuttaa vähimmäisoikeuksien käyttöoikeuden per integraatio.

    Q04

    Mitä käyttörajoja sovelletaan?

    Käyttörajat määräytyvät API-tason mukaan ja niitä sovelletaan per API-avain — taso ohjaa pyyntöjen läpäisykykyä, ei laskutusta. Vastausotsikot sisältävät rajan, jäljellä olevan kiintiön ja nollausaikaleimat, jotta voit hidastaa pyyntöjä siististi.

    Q05

    Missä voin testata päätepisteitä nopeasti?

    Käytä interaktiivista dokumentaatiota osoitteessa /api/v1/docs Swagger-testaukseen ja /api/v1/redoc viitetyylistä dokumentaatiota varten. OpenAPI-skeema tarjoillaan osoitteessa /api/v1/openapi.json.