Partner API Documentation

Intégrez Spartadoc dans vos systèmes. Vérification d'intégrité, résumés de souscription, gestion de partages — le tout via une API REST sécurisée.

v1.0.0RESTJSONHTTPS

Démarrage rapide

Trois étapes pour votre première requête :

Créez un compte Intégrateur

Inscrivez-vous sur Spartadoc avec le rôle INTEGRATOR.

Générez une clé API

Dans votre portail, créez une clé avec le scope approprié (read, write, admin).

Faites votre premier appel

curl -H "X-API-Key: sdoc_your_key_here" \
  https://api.spartadoc.com/api/partner/verify/a1b2c3d4...

Authentification

Toutes les requêtes partenaires utilisent une clé API transmise via l'en-tête X-API-Key.

GET /api/partner/verify/a1b2c3...
Host: api.spartadoc.com
X-API-Key: sdoc_a1b2c3d4e5f6...
Content-Type: application/json

Important: La clé API est affichée une seule fois lors de sa création. Conservez-la dans un gestionnaire de secrets. Ne la commitez jamais dans votre code source.

Niveaux d'accès (Scopes)

read Vérification & consultation

Vérifier l'intégrité (Merkle root), consulter la complétude d'un dossier, obtenir le résumé de souscription via un partage. Idéal pour les prêteurs et assureurs.

write Gestion des partages

Tout ce que read offre, plus la création et révocation de partages. Idéal pour les CRM de courtiers et les plateformes de soumission.

admin Accès complet

Tout ce que write offre, plus l'accès à la liste complète des dossiers et aux données extraites par l'IA. Idéal pour les fintechs et plateformes intégrées.

Cas d'usage

Prêteur

Vérifier l'intégrité et la complétude d'un dossier avant acceptation. Consulter les ratios ABD/ATD/RPV pré-calculés. Aucun accès aux documents originaux.

Scope: read

Courtier / CRM

Créer et révoquer des partages depuis un CRM existant. Automatiser la soumission au prêteur. Le courtier ne quitte jamais son outil.

Scope: write

Fintech

Accéder aux dossiers complets et aux données IA extraites pour alimenter vos modèles de risque, calculs de capacité et recommandations.

Scope: admin

Assureur / AMF

Valider la conformité d'un dossier sans y accéder. Vérification cryptographique via la racine Merkle. Audit d'intégrité irréfutable.

Scope: read

CRM — Réception email

Activer la réception de documents par courriel. L'emprunteur envoie à dossier-xxx@spartadoc.com. Gérer les expéditeurs autorisés.

Scope: write

CRM — Rappels SMS

Consulter et gérer les rappels SMS automatiques aux emprunteurs. Arrêter les rappels en cours.

Scope: write

Endpoints

Vérification

Partages

Dossiers

Email Gateway

Rappels

Clés API

La gestion des clés API utilise l'authentification JWT (pas la clé API). Connectez-vous avec votre compte INTEGRATOR.

Niveaux de sécurité

Chaque document a un niveau de sécurité qui détermine les protections appliquées et ce que l'API peut retourner.

LEVEL_1

Capsule simple

Chiffré AES-256. Métadonnées accessibles via API.

LEVEL_2

Capsule scellée

+ expiration + limite d'accès. Le partage peut expirer automatiquement.

LEVEL_3

Capsule verrouillée

+ TOTP requis. L'emprunteur doit valider chaque accès.

LEVEL_4

Capsule souveraine

+ chiffrement post-quantique ML-KEM-768. Résistant aux ordinateurs quantiques.

LEVEL_5

Capsule blindée

+ signature SLH-DSA. Preuve d'intégrité valide 25+ ans. Archivage long terme.

LEVEL_6

Capsule quantique (En R&D)

Sécurité par le quantique (distribution quantique de clés, QKD). En recherche et développement.

Note: Pour les niveaux 3+, l'API retourne les métadonnées et résumés, mais jamais le contenu brut des documents. L'accès au contenu nécessite l'autorisation explicite de l'emprunteur.

Codes d'erreur

401

Clé API manquante, invalide ou révoquée

403

Scope insuffisant pour cet endpoint

404

Ressource non trouvée ou partage expiré/révoqué

429

Limite de requêtes dépassée (1000/h par défaut)

500

Erreur interne — contactez api@spartadoc.com

Format d'erreur

{ "error": "Insufficient API key scope", "required": ["write"], "current": "read" }

Bonnes pratiques

Ne stockez jamais la clé API dans le code source. Utilisez des variables d'environnement.

Utilisez le scope minimal nécessaire. read suffit pour la vérification.

Gérez les expirations de partage. Un partage peut être révoqué à tout moment par l'emprunteur.

Vérifiez le completenessScore avant d'agir. Un score < 0.80 indique un dossier incomplet.

Conservez le merkleRoot comme preuve. C'est votre ancrage d'intégrité.

Préparez-vous pour les webhooks. Une future version notifiera les partenaires en temps réel.

Spartadoc — L'encapsuleur de documents que vos données méritent

api@spartadoc.com — Spartadoc Q, Spartadoc Inc.