Documentation technique

Guide d’intégration API CheckFile

Intégrez la vérification documentaire par IA dans votre application en quelques heures. Authentification, endpoints, webhooks et gestion des erreurs.

Intégration en 4 étapes

Obtenez votre clé API

Créez un compte CheckFile et générez une clé API depuis votre dashboard. Mode sandbox disponible pour les tests.

Soumettez un dossier

Envoyez les documents via POST /api/v1/dossiers avec les fichiers en multipart/form-data. Chaque dossier reçoit un identifiant unique.

Recevez les résultats

L’analyse est asynchrone. Récupérez les résultats via GET /api/v1/dossiers/{id} ou configurez un webhook pour être notifié automatiquement.

Configurez les webhooks

Enregistrez une URL de callback via POST /api/v1/webhooks. Vous recevrez un événement dossier.completed avec le résultat complet.

Authentification

Toutes les requêtes nécessitent un en-tête Authorization avec votre clé API. Les clés commencent par cf_live_ (production) ou cf_test_ (sandbox).

HTTP Header

Authorization: Bearer cf_live_your_api_key_here

Code examples

cURL

curl -X POST https://api.checkfile.ai/api/v1/dossiers \
  -H "Authorization: Bearer cf_live_your_key" \
  -F "partner_id=your_partner" \
  -F "reference=DOSSIER-2026-001" \
  -F "files[]=@identity.pdf" \
  -F "files[]=@proof_of_address.pdf" \
  -F "files[]=@payslip.pdf"

Endpoints principaux

POST/api/v1/dossiers

Créer un nouveau dossier de vérification

GET/api/v1/dossiers/{id}

Récupérer le statut et les résultats d’un dossier

GET/api/v1/dossiers

Lister tous les dossiers (pagination, filtres)

DELETE/api/v1/dossiers/{id}

Supprimer un dossier (conformité RGPD)

POST/api/v1/webhooks

Enregistrer un webhook de notification

GET/api/v1/rules

Lister les règles métier configurées

Structure de la réponse

Chaque dossier retourné contient un score de confiance global, le détail par document, les alertes détectées et les données extraites.

JSON Response

{
  "id": "dos_abc123",
  "status": "completed",
  "confidence_score": 0.97,
  "reference": "DOSSIER-2026-001",
  "created_at": "2026-03-28T10:30:00Z",
  "documents": [
    {
      "type": "identity",
      "filename": "identity.pdf",
      "status": "valid",
      "extracted_data": {
        "full_name": "Jean Dupont",
        "date_of_birth": "1985-06-15",
        "document_number": "123456789",
        "expiry_date": "2028-01-01"
      },
      "alerts": []
    },
    {
      "type": "proof_of_address",
      "filename": "proof_of_address.pdf",
      "status": "valid",
      "extracted_data": {
        "full_name": "Jean Dupont",
        "address": "12 rue de la Paix, 75002 Paris"
      },
      "alerts": []
    }
  ],
  "cross_validation": {
    "name_consistency": true,
    "address_consistency": true,
    "alerts": []
  }
}

Gestion des erreurs

L’API utilise les codes HTTP standards. Les erreurs incluent un code machine et un message lisible.

400Requête invalide (paramètre manquant ou format incorrect)

401Clé API invalide ou expirée

404Dossier non trouvé

429Limite de débit atteinte (100 req/min par défaut)

500Erreur serveur (réessayez avec backoff exponentiel)

Limites et quotas

Requêtes par minute

100 (extensible sur demande)

Taille max par fichier

20 Mo

Documents par dossier

50 max

Formats acceptés

PDF, JPG, PNG, TIFF, HEIC

Cas d’usage par secteur

Banque & Fintech

Onboarding KYC automatisé : soumission des pièces d’identité, justificatifs de domicile et bulletins de salaire pour ouverture de compte.

Immobilier

Vérification des dossiers locataires : analyse croisée des 10+ documents du dossier en moins d’une minute.

RH & Intérim

Contrôle des documents d’embauche : vérification du titre de séjour, diplômes et attestations en temps réel.

Consulter la référence API complète Fonctionnalité API REST

Prêt à intégrer ?

Créez votre compte sandbox gratuitement et testez l’API en quelques minutes.