API SPEC · V1 · GADEVELOPER REFERENCE

    API développeur

    API REST pour le criblage LCB-FT

    Intégrez le criblage des sanctions, des PPE, des listes criminelles, des médias défavorables et KYB/UBO directement dans vos flux d'entrée en relation, de surveillance et de transaction. L'API est en production : authentifiez-vous avec une clé d'API et appelez le même moteur de criblage que celui du portail.

    L'API v1 est en production

    Les endpoints sont généralement disponibles avec authentification par clé d'API et limites de débit par palier. Explorez chaque endpoint dans la documentation OpenAPI interactive à /api/v1/docs.

    §01Démarrage rapide

    01 / 05
    STEP 01

    1. Créer une clé d'API

    Créez une clé d'API à portée limitée depuis votre tableau de bord, ou générez-en une par programmation avec votre jeton bearer de compte pour des requêtes serveur à serveur.

    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. Exécuter votre première recherche

    Soumettez une entité avec l'en-tête X-API-Key. L'API renvoie un identifiant de recherche que vous récupérez une fois le traitement terminé.

    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. Soumettre un lot

    Envoyez un fichier CSV/XLSX pour cribler plusieurs entités en une seule tâche, puis récupérez les lignes ou exports une fois le lot terminé.

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

    §02Endpoints principaux

    02 / 05
    EP 01ENDPOINT

    POST /api/v1/search

    Crée une demande de criblage pour une entité. Renvoie un identifiant de recherche et un statut de traitement. Les endpoints de compte, de couverture et de santé sont également disponibles sous /api/v1.

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

    EP 02ENDPOINT

    POST /api/v1/batch

    Soumettez des fichiers CSV/XLSX pour un criblage à fort volume, puis récupérez les lignes ou exports une fois les tâches terminées.

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

    EP 03ENDPOINT

    POST /api/v1/keys

    Créez et gérez des identifiants API avec permissions à portée limitée, limites de débit selon le palier, et suivi d'utilisation.

    Auth : jeton Bearer (compte)

    §03Pourquoi les équipes utilisent l'API

    03 / 05
    • Une seule intégration pour le criblage des sanctions, des PPE, des listes criminelles, des médias défavorables et KYB/UBO
    • Authentification par clé d'API via l'en-tête X-API-Key, avec clés à portée limitée pour un accès à moindre privilège
    • Limites de débit par palier avec journalisation d'utilisation pour la gouvernance et la maîtrise des coûts
    • Endpoints de recherche, de lots, de clés, de compte, de couverture et de santé sous /api/v1
    • Documentation OpenAPI interactive à /api/v1/docs, plus un schéma OpenAPI lisible par machine
    • Sortie structurée adaptée aux journaux d'audit, dossiers de cas et décisions en aval

    §05FAQ API

    05 / 05
    Q01

    Comment authentifier les requêtes API ?

    Les requêtes de criblage vers /api/v1/search et /api/v1/batch s'authentifient avec une clé d'API envoyée dans l'en-tête X-API-Key. Créez des clés depuis votre tableau de bord, ou par programmation via /api/v1/keys après authentification avec le jeton bearer de votre compte.

    Q02

    L'API est-elle généralement disponible ?

    Oui. L'API v1 est en production et généralement disponible. Authentifiez-vous avec une clé d'API, appelez les endpoints de recherche, de lots et de gestion des clés, et explorez tout dans la documentation OpenAPI interactive à /api/v1/docs.

    Q03

    Puis-je limiter la portée des permissions de clé d'API ?

    Oui. Les clés prennent en charge des permissions telles que search:read, search:write, batch:read et batch:write afin que vous puissiez appliquer un accès à moindre privilège par intégration.

    Q04

    Quelles limites de débit s'appliquent ?

    Les limites de débit sont attribuées par palier d'API et appliquées par clé d'API — le palier détermine le débit des requêtes, pas la facturation. Les en-têtes de réponse incluent la limite, le quota restant et les horodatages de réinitialisation afin que vous puissiez ralentir proprement.

    Q05

    Où puis-je tester rapidement les endpoints ?

    Utilisez la documentation interactive à /api/v1/docs pour des tests Swagger et /api/v1/redoc pour une documentation de référence. Le schéma OpenAPI est servi à /api/v1/openapi.json.