Naar hoofdinhoud springen
ShieldID

Ontwikkelaars

Documentatie voor de API voor identiteitsverificatie, gemaakt om echt te gebruiken.

Eén REST API, een gehoste pagina voor de onderdelen die u niet zelf wilt bouwen, en ondertekende webhooks, zodat u het op het moment zelf weet als er een resultaat is. Sandbox-sleutels worden nooit gefactureerd, dus de snelste manier om ShieldID te begrijpen is het aan te roepen.

Gratis starten in de sandboxLees de quickstart

De versie van vijf minuten

Vier aanroepen. Eén denkmodel.

Al het andere in deze documentatie is detail bovenop deze lus.

  1. Maak een sessie aan

    POST /v1/sessions met een return-URL en een webhook-URL. U krijgt een session_id en een verification_url terug.

  2. Geef het door aan de aanvrager

    Stuur de verification_url als link, of laat de aanvrager de QR-code scannen die de gehoste pagina op desktop toont. De aanvrager rondt het af op de eigen telefoon.

  3. Ontvang een ondertekende webhook

    Wanneer de sessie de status VERIFIED of FAILED bereikt, stuurt ShieldID het resultaat via POST naar uw webhook-URL, ondertekend zodat u erop kunt vertrouwen dat het van ons afkomstig is.

  4. Lees het resultaat

    Vertrouw op de webhook, of roep zelf GET /v1/sessions/{id}/result aan. In beide gevallen krijgt u uitslagen per controle, geen ondoorzichtige eindscore.

Probeer het

Maak uw eerste sessie aan.

Hetzelfde verzoek in drie talen. Dit is de aanroep die stap één van het denkmodel beschrijft.

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" }

Sandbox-sleutels (vk_sand_…) doorlopen precies deze flow gratis. Schakel over op een vk_live_-sleutel en er verandert niets behalve de factuur.

Vind uw weg

De rest van de ontwikkelaarsdocumentatie.

Zes pagina's. Lees de pagina's die u nodig hebt.

Quickstart

Van sandbox-sleutel tot eerste ondertekende webhook, in volgorde.
Openen Quickstart

SDKs

De webwidget, de gehoste flow en wat er nog komt.
Openen SDKs

Sandbox

Test de hele flow voordat u iets ondertekent.

Een sandbox-sleutel (prefix vk_sand_) draait dezelfde API, gehoste pagina en webhook-flow als productie. Sessies worden overal waar ze verschijnen gemarkeerd met environment: "sandbox", en sandbox-sessies worden nooit gefactureerd, bij geen enkel abonnement.

Lees de sandbox-gids
  • Maak echte sessies aan, verifieer een echt document op uw eigen telefoon en ontvang een echte ondertekende webhook terug
  • Niets wat u in de sandbox doet, komt op een factuur terecht
  • Schakel over naar productie door de sleutelprefix te vervangen; de vorm van het verzoek verandert niet

Openlijk gebouwd

Wat af is, en wat nog niet.

We vertellen het u liever dan dat u er halverwege de integratie achter komt.

Callbacks voor voltooiing van de webwidget

Binnenkort beschikbaar

onComplete, onCancel en onStep bestaan vandaag al in de interface van de widget, maar er wordt nog niets mee geactiveerd. Gebruik de return-URL en de webhook — beide werken nu.

Afgedwongen rate limits

Binnenkort beschikbaar

Elke API-sleutel heeft een rate limit die bij uw abonnement is vastgelegd, maar die wordt nog niet afgedwongen bij verzoeken — houd daar rekening mee en reken er niet op dat ShieldID u afremt.

Zelfstandige sandbox-aanmelding

Binnenkort beschikbaar

Sandbox-sleutels worden op aanvraag verstrekt zolang zelfbediening-aanmelding nog in ontwikkeling is. Vraag er een aan en wij regelen het snel.

Vragen

Duidelijke antwoorden voor ontwikkelaars.

Aan de slag

Ga in een middag live.

Begin met een sandbox-sleutel, voer een verificatie uit op uw eigen telefoon en lees de webhook die u ontvangt. Geen verkoopgesprek nodig.

Gratis starten in de sandboxLees de quickstart

Sandbox-sessies worden nooit gefactureerd.