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
- npm
- yarn
É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
Votre Public Merchant Key, disponible dans la section API / Webhook de votre tableau de bord.
Définissez
true pour utiliser le mode sandbox pendant le développement et les tests. Définissez false pour la production.Définissez
true pour masquer l’option de capture du document avec un second appareil.Personnalisez le message d’accueil, le texte du bouton et les couleurs. Tous les champs sont facultatifs.
Limitez la capture à certains pays et types de documents. Chaque élément est un objet. Tous les champs sont facultatifs.
Toute autre information que vous souhaitez envoyer à l’URL de votre webhook. Utilisez vos propres clés.
Appelée lorsque la capture de documents produit un résultat. Consultez Résultat en cas de succès.
Résultat en cas de succès
Lorsque la capture réussit,onSuccess reçoit un objet de ce type :
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 avecsetShowModal. La méthode prend un booléen et ne renvoie rien.