SDKs
Le SDK de vérification d'identité, et la voie sans SDK.
La plupart des intégrations n'ont pas du tout besoin de SDK — la page hébergée fait le travail. Le widget web est là lorsque vous voulez que le parcours reste dans votre propre page. Les SDK mobiles natifs sont la prochaine étape.
La voie sans SDK
La page hébergée n'a besoin d'aucun SDK, sur toutes les plateformes.
POST /v1/sessions renvoie une verification_url. Envoyez-la au demandeur de la manière dont votre produit envoie déjà des liens — courriel, SMS, redirection dans l'application, code QR à l'écran — et ShieldID s'occupe de la capture, du défi de preuve de vie et du égoportrait sur son propre téléphone.
- Fonctionne à partir d'une application web, du navigateur système ou d'une WebView d'une application native, d'un lien dans un courriel ou d'un code QR sur une borne — rien à installer
- Image de marque en marque blanche sur les forfaits admissibles, pour que le parcours ne ressemble pas à une redirection vers un tiers
- Les résultats vous parviennent par la redirection return_url et le webhook signé — aucun câblage de rappel côté client n'est nécessaire
Le widget web
Intégrez le parcours dans votre propre page.
Un petit script qui affiche le parcours de vérification hébergé dans un iframe sur votre page, au lieu d'éloigner le demandeur de celle-ci.
Ce qui fonctionne aujourd'hui
- TLVerify.init({ apiKey, containerId, returnUrl, cancelUrl, webhookUrl, locale, theme }) crée une session et l'affiche dans l'élément de votre choix
- Exécute le même parcours de capture que la page hébergée, dans votre mise en page, avec votre accentColor et votre logo
- Fonctionne dès aujourd'hui pour créer une session et afficher le parcours en ligne
Rappels d'achèvement
Bientôt disponibleonComplete, onCancel, onStep et le redimensionnement automatique de l'iframe font partie de l'interface du widget, mais rien dans le parcours ne les déclenche pour l'instant. Ne développez pas de logique qui dépend de leur déclenchement — utilisez plutôt l'URL de retour et le webhook, qui fonctionnent tous deux dès aujourd'hui.
Une remarque sur les clés API dans le navigateur
L'appel init() du widget est documenté comme acceptant une apiKey brute dans du JavaScript côté client. Nous ne le recommandons pas en production : quiconque affiche le code source obtient votre clé. Créez plutôt la session sur votre serveur avec POST /v1/sessions, puis transmettez au widget la verification_url obtenue pour l'affichage — la même recommandation que pour le parcours hébergé, mais intégré plutôt que lié.
<div id="shieldid-verify"></div>
<!-- Exact script URL is published with your API keys; the path below is illustrative. -->
<script src="https://cdn.shieldid.ca/sdk/v1/widget.js"></script>
<script>
// Recommended: create the session on your backend first (see API reference),
// then pass its verification_url straight through — never a raw API key.
TLVerify.init({
containerId: "shieldid-verify",
verificationUrl: "{{ session.verification_url }}", // from your backend
theme: { accentColor: "#0B5CD8" },
});
</script>Mobile
Les SDK natifs s'en viennent.
Il n'existe actuellement aucun SDK iOS ou Android. D'ici là, ouvrez la page de vérification hébergée dans le navigateur système de votre application ou dans une WebView — c'est le même parcours que celui d'un demandeur sur le web, et il fonctionne dès maintenant, sur toute plateforme où s'exécute votre application.
Bientôt disponibleSDK natifs iOS et Android
Choisir une voie
Trois façons de s'y prendre, comparées honnêtement.
Commencez par la page hébergée, à moins d'avoir une raison précise d'intégrer le parcours.
| Capacité | Page hébergée | Widget web | SDK mobile |
|---|---|---|---|
| Aucun SDK, aucun code côté client | Oui | Non | Bientôt disponible |
| Reste dans votre propre page | S'ouvre sous forme de lien | iframe intégré | Bientôt disponible |
| Rappels de fin d'opération dans votre code | URL de retour + webhook | Bientôt disponible | Bientôt disponible |
| Votre image de marque | Sur les forfaits admissibles | Sur les forfaits admissibles | Bientôt disponible |
| Fonctionne dès aujourd'hui | Oui | Oui | Non |
Questions
FAQ du SDK et du widget.
Commencez à développer
La page hébergée est le moyen le plus rapide de démarrer.
Un appel d'API, un lien, aucun SDK requis. Essayez dès aujourd'hui avec une clé de bac à sable.