Passer au contenu principal
ShieldID

Développeurs

Une documentation de l'API de vérification d'identité conçue pour être réellement utilisée.

Une seule API REST, une page hébergée pour les parties que vous ne voulez pas développer, et des webhooks signés pour savoir dès qu'un résultat est disponible. Les clés de bac à sable ne sont jamais facturées, alors le moyen le plus rapide de comprendre ShieldID est de l'appeler.

Commencer gratuitement dans le bac à sableLire le guide de démarrage rapide

La version en cinq minutes

Quatre appels. Un seul modèle mental.

Tout le reste de cette documentation n'est que du détail qui s'ajoute à cette boucle.

  1. Créez une session

    POST /v1/sessions avec une URL de retour et une URL de webhook. Vous recevez en retour un session_id et une verification_url.

  2. Transmettez-le au demandeur

    Envoyez la verification_url sous forme de lien, ou laissez le demandeur numériser le code QR affiché par la page hébergée sur ordinateur. Il termine sur son propre téléphone.

  3. Recevez un webhook signé

    Lorsque la session atteint VERIFIED ou FAILED, ShieldID envoie le résultat par POST à l'URL de votre webhook, signé afin que vous puissiez vous assurer qu'il provient bien de nous.

  4. Lisez le résultat

    Faites confiance au webhook, ou appelez vous-même GET /v1/sessions/{id}/result. Dans les deux cas, vous obtenez des verdicts par vérification, et non une seule note opaque.

Essayez-le

Créez votre première session.

La même requête dans trois langages. C'est l'appel que décrit la première étape du modèle conceptuel.

bash
# Create a verification session (sandbox keys are never billed)
curl -X POST https://api.shieldid.ca/v1/sessions \
  -H "X-Api-Key: vk_sand_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "return_url": "https://yourapp.example/verified",
    "webhook_url": "https://yourapp.example/hooks/shieldid"
  }'

# → { "session_id": "…", "verification_url": "https://…/v/…", "environment": "sandbox" }

Les clés de bac à sable (vk_sand_…) exécutent exactement ce parcours gratuitement. Remplacez-les par une clé vk_live_ et rien d'autre ne change, sauf la facture.

Trouvez votre chemin

Le reste de la documentation pour les développeurs.

Six pages. Lisez celles dont vous avez besoin.

SDKs

Le widget Web, le parcours hébergé et ce qui s'en vient.
Ouvrir SDKs

Statut

Ce sur quoi nous ferons rapport, une fois le fil en ligne.
Ouvrir Statut

Bac à sable

Testez tout le parcours avant de signer quoi que ce soit.

Une clé de bac à sable (préfixe vk_sand_) exécute la même API, la même page hébergée et le même flux de webhook qu'en production. Les sessions sont estampillées environment: "sandbox" partout où elles apparaissent, et les sessions du bac à sable ne sont jamais facturées, quel que soit le forfait.

Lire le guide du bac à sable
  • Créez de vraies sessions, vérifiez un vrai document sur votre propre téléphone, recevez en retour un vrai webhook signé
  • Rien de ce que vous faites dans le bac à sable n'a d'incidence sur une facture
  • Passez en production en changeant le préfixe de la clé ; la forme de la requête ne change pas

Conçu au grand jour

Ce qui est terminé, et ce qui ne l'est pas encore.

Nous préférons vous le dire plutôt que de vous laisser le découvrir en pleine intégration.

Rappels d'achèvement du widget Web

Bientôt disponible

onComplete, onCancel et onStep existent dans l'interface du widget aujourd'hui, mais rien ne les déclenche encore. Utilisez l'URL de retour et le webhook : les deux fonctionnent dès maintenant.

Limites de débit appliquées

Bientôt disponible

Chaque clé API est associée à une limite de débit enregistrée selon votre forfait, mais elle n'est pas encore appliquée aux requêtes : planifiez en conséquence et ne comptez pas sur ShieldID pour limiter votre débit.

Inscription en libre-service au bac à sable

Bientôt disponible

Les clés de bac à sable sont émises sur demande pendant que l'inscription en libre-service est en cours de développement. Demandez-en une et nous vous la remettrons rapidement.

Questions

Des réponses directes pour les développeurs.

Commencer

Mettez en service en un après-midi.

Commencez avec une clé de bac à sable, effectuez une vérification sur votre propre téléphone et lisez le webhook qu'elle vous envoie. Aucun appel de vente requis.

Commencer gratuitement dans le bac à sableLire le guide de démarrage rapide

Les sessions du bac à sable ne sont jamais facturées.