Documentation pour développeurs Certivant
Développez avec l'API Certivant — KYC, KYB, envoi de documents, sessions hébergées et événements webhook.
Bienvenue dans la documentation pour développeurs de Certivant. Il s'agit de la référence technique pour intégrer la plateforme KYC et KYB de Certivant à votre propre produit.
Si vous cherchez comment utiliser Certivant dans le navigateur, consultez plutôt la documentation pour les locataires : ce site suppose que vous écrivez du code qui communique avec l'API REST.
Ce que vous pouvez créer
- Effectuer une vérification d'identité (KYC) depuis votre propre application : soumettez un demandeur, recueillez les documents via une session hébergée ou votre propre interface, puis recevez une décision d'approbation, de rejet ou d'escalade.
- Effectuer une vérification d'entreprise (KYB) : soumettez les coordonnées de l'entreprise, les administrateurs et les bénéficiaires effectifs ultimes, puis vérifiez-les auprès des registres et des listes de sanctions.
- Recevoir des webhooks en temps réel lorsqu'une demande change d'état, qu'un document est envoyé ou qu'une vérification se termine.
- Gérer les demandes depuis le tableau de bord grâce à votre propre automatisation : les mêmes points de terminaison alimentent l'interface web de Certivant.
- Attribuer les demandes à vos propres clients (mode partenaire) : effectuez des vérifications pour de nombreux clients finaux au sein d'une même organisation, associez chaque demande à un nom de sous-locataire et à un identifiant externe, puis filtrez ou acheminez-les selon ces informations dans l'API et les webhooks.
En bref
| URL de base | https://app.certivant.com/api/v1/kyc |
| Authentification | Authorization: Bearer ck_live_… ou ck_test_… (clé d'API, propre à chaque organisation ; les anciennes clés kyk_… fonctionnent toujours) |
| Type de contenu | application/json (ou multipart/form-data pour l'envoi de documents) |
| Limite de débit | Selon le forfait : voir Limites de débit |
| Signature des webhooks | X-Certivant-Signature-V2: t=…,v1=… (HMAC-SHA256 sur timestamp.body, tolérance de 300 s) : voir Vérification de la signature |
| Référence interactive | Référence de l'API, ou ouvrez directement /api/v1/docs : public, généré à partir du schéma OpenAPI |
| Schéma OpenAPI | /api/v1/openapi.json : OpenAPI 3.1 public, sans connexion |
Un seul hôte, et non un sous-domaine par locataire. Sur le service hébergé, toutes les organisations partagent le même hôte, app.certivant.com : il n'existe pas de votre-org.certivant.com. Utilisez donc app.certivant.com tel quel dans ces exemples. (Les déploiements auto-hébergés utilisent le domaine configuré par l'opérateur ; certivant.com correspond au site marketing, et non à l'application.) Pour l'API, votre organisation est identifiée par votre clé d'API, jamais par l'URL : le chemin de base est /api/v1/kyc, sans identifiant d'organisation. Cet identifiant (slug) n'apparaît que là où un humain navigue : le tableau de bord à l'adresse /app/{slug-organisation} et les liens de formulaires et de sessions hébergés comme /forms/{slug}. Un domaine personnalisé en marque blanche peut faire pointer ces liens destinés aux utilisateurs vers votre propre domaine, mais l'hôte de l'API reste inchangé.
La référence interactive et le schéma OpenAPI brut sont publics : aucune connexion ni clé d'API n'est nécessaire, et ils ne décrivent que les points de terminaison d'intégration (/api/v1). Voir Référence de l'API.
Premiers pas
Référence
- Formulaires : listez les formulaires KYC et KYB du locataire pour choisir celui à utiliser pour une vérification.
- Demandes KYC : créez, listez, consultez, soumettez, décidez et renvoyez.
- Demandes KYB : vérification d'entreprise avec administrateurs et bénéficiaires effectifs.
- Documents : envoyez des documents d'identité et récupérez des URL de téléchargement signées.
- Sessions hébergées : générez une URL à courte durée de vie où le demandeur complète le parcours.
- Liste de blocage : ajoutez et retirez des adresses courriel, numéros de téléphone, numéros de document et adresses IP bloqués, ou bloquez le visage, l'appareil et l'adresse IP associés à une vérification.
- Vérification de l'âge : estimez à partir d'un selfie si une personne est majeure, avec un repli sur la date de naissance figurant sur la pièce d'identité.
- Vérifications réutilisées : permettez à un demandeur ayant déjà réussi une vérification Certivant ailleurs de la réutiliser chez vous (particuliers et entreprises).
- Intégrer dans votre site ou application : affichez une vérification dans votre propre page grâce à une seule balise script, ou dans une WebView React Native ou Flutter.
- Référence de l'API (OpenAPI) : le document OpenAPI 3.1 public et la référence interactive.
- Vérification en direct : planifiez, suivez, reprogrammez ou annulez une session de vérification d'identité en direct animée par un humain, et recevez la décision par webhook.
- Live ID Validation : ouverture de session biométrique : comparez le selfie en direct d'un utilisateur récurrent avec le visage de sa vérification KYC.
- Serveur MCP : connectez un assistant IA à votre file de vérification via le Model Context Protocol.
- Webhooks : enregistrez une URL, vérifiez les signatures et gérez les nouvelles tentatives.
- Erreurs : codes d'erreur, correspondance avec les statuts HTTP, structure des champs de validation.
- Limites de débit : quotas, en-têtes et stratégie de nouvelle tentative.
- Schémas : énumérations, valeurs de statut, structures de requête et de réponse que vous rencontrerez souvent.