Vérifier un document avec l'API
Envoie un PDF à l'API REST VerifyPDF avec ta clé API dans l'en-tête API-KEY. Chaque vérification consomme un document et renvoie le même résultat que le tableau de bord.
L’API REST VerifyPDF permet à tes propres systèmes de vérifier des documents sans que personne n’ouvre le tableau de bord. Cet article couvre le flux global. Pour tous les détails de requête et de réponse, utilise la référence sur /agents/.
Avant de commencer
- L’API REST est disponible sur les forfaits Professional et Corporate. Elle n’est pas incluse sur Basic ni sur un compte sans forfait. Voir Les forfaits expliqués.
- Il te faut une clé API. Voir Générer et gérer des clés API.
Le flux de base
- Crée une clé API dans la section Développeurs et copie-la une fois.
- Envoie le PDF à l’API avec ta clé dans l’en-tête de requête
API-KEY. - Lis le résultat, qui revient avec le même score de confiance et le même niveau de risque de fraude que ceux que tu vois dans le tableau de bord. Voir Lire ton résultat de vérification.
Chaque vérification par API consomme un document de ton allocation mensuelle ou de ton solde prépayé, exactement comme un téléversement depuis le tableau de bord. Voir Comment fonctionnent les packs prépayés.
Ajoute ta propre référence
Tu peux attacher un custom_id à une vérification, par exemple ton numéro de dossier interne ou ton identifiant de commande. Cela te permet de retrouver la vérification plus tard grâce à ta propre référence. Chaque custom_id doit être unique dans ton compte.
Une illustration rapide
Au niveau global, une requête envoie le PDF accompagné de l’en-tête API-KEY contenant ta clé. Le point de terminaison exact, le corps de la requête et le format de réponse se trouvent dans la référence de l’API sur /agents/ et dans la section Développeurs du tableau de bord. Utilise-les pour des exemples prêts à copier plutôt que de deviner.
Teste d’abord, puis passe en live
Pendant que tu développes, utilise une clé test. Passe à une clé live pour les vraies vérifications. Voir Clés API de test et live.
Et après
- Tu veux que les résultats te soient transmis plutôt que d’interroger ? Voir Configurer des webhooks.
- Tu as besoin de la référence complète ? Va sur /agents/.