Passer au contenu principal
Utilisez le SDK Web de Youverify pour permettre à vos utilisateurs de capturer une pièce d’identité depuis votre application web. Le SDK ouvre une fenêtre modale, guide l’utilisateur pendant la capture du document, puis renvoie les informations extraites à votre page.

Avant de commencer

Vous avez besoin de votre Public Merchant Key (clé marchand publique). Vous la trouverez dans la section API / Webhook de votre tableau de bord Youverify. Elle peut être utilisée sans risque dans du code côté client.
La capture de documents sur le web s’initialise avec votre Public Merchant Key. Vous n’avez pas besoin de générer d’identifiant de session sur votre serveur pour ce parcours. Gardez votre clé d’API secrète sur votre serveur et ne la placez jamais dans une page web.

Installation

Étapes d’intégration

1

Créer le module de capture de documents

Transmettez vos options à YouverifySDK.documentCapture :
2

Initialiser le module

Appelez initialize() une seule fois. La méthode lève une erreur si les options sont invalides ; placez-la donc dans un bloc try.
3

Démarrer le parcours de capture

Appelez start() lorsque votre utilisateur est prêt, par exemple au clic sur un bouton. Cela ouvre la fenêtre modale.

Options

string
requis
Votre Public Merchant Key, disponible dans la section API / Webhook de votre tableau de bord.
boolean
défaut:"false"
Définissez true pour utiliser le mode sandbox pendant le développement et les tests. Définissez false pour la production.
boolean
défaut:"false"
Définissez true pour masquer l’option de capture du document avec un second appareil.
object
Attributs de l’utilisateur servant à personnaliser l’expérience.
object
Personnalisez le message d’accueil, le texte du bouton et les couleurs. Tous les champs sont facultatifs.
array
Limitez la capture à certains pays et types de documents. Chaque élément est un objet. Tous les champs sont facultatifs.
object
Toute autre information que vous souhaitez envoyer à l’URL de votre webhook. Utilisez vos propres clés.
(data) => void
Appelée lorsque la capture de documents produit un résultat. Consultez Résultat en cas de succès.
(error) => void
Appelée lorsque le résultat n’a pas pu être récupéré. Reçoit un objet d’erreur.
() => void
Appelée lorsque la fenêtre modale est fermée.
Pour connaître les pays, provinces et types de documents pris en charge, consultez Couverture par pays et par produit.

Résultat en cas de succès

Lorsque la capture réussit, onSuccess reçoit un objet de ce type :
string
Image base64 du recto du document.
string
Image base64 du verso du document.
string
Image base64 du recto du document. Présente lorsque le document n’a pas de verso à capturer.
Le résultat contient des données personnelles et des images du document. Envoyez-le à votre backend via HTTPS, et ne l’écrivez pas dans les journaux ni ne le stockez dans le navigateur.
Si vous ne transmettez pas de callback onSuccess, il ne se passe rien lorsque la capture réussit.

Fermer la fenêtre modale par le code

Vous pouvez fermer la fenêtre modale du SDK depuis votre propre code avec setShowModal. La méthode prend un booléen et ne renvoie rien.

Utilisation dans une application mobile

Il n’existe pas encore de SDK mobile natif pour la capture de documents. Pour la proposer dans une application Android ou iOS, vous pouvez encapsuler cette intégration web dans une WebView. Consultez Utiliser la capture de documents dans une application mobile.