Moet ik de gehoste pagina of de widget gebruiken?

Begin met de gehoste pagina — die vereist één API-aanroep en geen client-side code. Kies alleen voor de widget als het belangrijk genoeg is om de aanvrager binnen uw eigen layout te houden om een iframe-integratie en de huidige beperkingen van de callbacks op de koop toe te nemen.

Waarom worden de callbacks onComplete en onCancel van de widget niet geactiveerd?

De gehoste pagina in de iframe verstuurt de berichten waarop de widget luistert nog niet. Dit is een bekende tekortkoming, geen configuratiefout aan uw kant. Gebruik de return_url en de webhook, die beide nu al werken, totdat dit is opgelost.

Is het veilig om mijn API-sleutel in de init()-aanroep van de widget te plaatsen?

Technisch gezien accepteert de widget dit, maar wij raden het af: een onbeveiligde sleutel in client-side JavaScript is zichtbaar voor iedereen die de broncode bekijkt. Maak de sessie server-side aan en geef de widget in plaats daarvan de resulterende verification_url.

Is er een React- of mobiele component?

Nog niet. De webwidget is momenteel een gewone script-tag; native iOS- en Android-SDKs zijn gepland. Intussen werkt de gehoste pagina in een WebView of de systeembrowser.

Ondersteunt de widget Frans?

Ja — geef locale: "fr" mee op dezelfde manier als bij de API, en de flow in de iframe wordt in het Frans weergegeven.

SDKs

De SDK voor ID-verificatie, en het pad zonder SDK.

De meeste integraties hebben helemaal geen SDK nodig: de gehoste pagina doet het werk. De webwidget is er voor wanneer u wilt dat de flow binnen uw eigen pagina blijft. Native mobiele SDKs volgen daarna.

Lees de quickstart API-referentie

Het pad zonder SDK

De gehoste pagina heeft op elk platform geen SDK nodig.

POST /v1/sessions retourneert een verification_url. Stuur die naar de aanvrager op de manier waarop uw product al links verstuurt, via e-mail, sms, een in-app-redirect of een QR-code op een scherm, en ShieldID verzorgt de opname, de liveness-controle en de selfie op de eigen telefoon van de aanvrager.

Werkt vanuit een webapp, de systeembrowser of WebView van een native app, een e-maillink of een QR-code op een kiosk. Er hoeft niets te worden geïnstalleerd
White-label-branding bij in aanmerking komende abonnementen, zodat het er niet uitziet als een overdracht aan een derde partij
Resultaten bereiken u via de return_url-redirect en de ondertekende webhook, zonder dat u client-side callbacks hoeft te koppelen

Bekijk het endpoint van de gehoste pagina

De webwidget

Een klein script dat de gehoste verificatieflow in een iframe op uw pagina weergeeft, in plaats van de aanvrager ervan weg te sturen.

Wat vandaag werkt

TLVerify.init({ apiKey, containerId, returnUrl, cancelUrl, webhookUrl, locale, theme }) maakt een sessie aan en koppelt die aan een element naar keuze
Voert dezelfde opnameflow uit als de gehoste pagina, binnen uw eigen layout, met uw accentColor en logo
Werkt nu al voor het aanmaken van een sessie en het inline tonen van de flow

Callbacks bij voltooiing

Binnenkort beschikbaar

onComplete, onCancel, onStep en automatische iframe-aanpassing van het formaat maken deel uit van de interface van de widget, maar binnen de flow wordt er nog niets door geactiveerd. Bouw geen logica die ervan afhankelijk is dat ze worden aangeroepen — gebruik in plaats daarvan de return-URL en de webhook, die beide nu al werken.

Een opmerking over API-sleutels in de browser

Volgens de documentatie accepteert de init()-aanroep van de widget zelf een onbeveiligde apiKey in client-side JavaScript. Wij raden dat in productie af: iedereen die de broncode bekijkt, krijgt uw sleutel in handen. Maak de sessie in plaats daarvan aan op uw backend met POST /v1/sessions en geef de widget de resulterende verification_url om weer te geven — dezelfde aanbeveling als bij de gehoste flow, alleen ingebed in plaats van gekoppeld.

html

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

Mobiel

Native SDKs komen eraan.

Er is momenteel geen iOS- of Android-SDK. Open tot die er is de gehoste verificatiepagina in de systeembrowser van uw app of in een WebView — het is dezelfde flow die een webaanvrager krijgt, en die werkt nu al op elk platform waarop uw app draait.

Binnenkort beschikbaarNative iOS- en Android-SDKs

Een pad kiezen

Drie manieren om te beginnen, eerlijk vergeleken.

Begin met de gehoste pagina, tenzij u een specifieke reden hebt om te embedden.

Wat elk integratiepad u vandaag biedt.
Mogelijkheid	Gehoste pagina	Webwidget	Mobile SDK
Geen SDK, geen client-side code	Ja	Nee	Binnenkort beschikbaar
Blijft binnen uw eigen pagina	Opent als link	Ingebedde iframe	Binnenkort beschikbaar
Completion-callbacks in uw code	Return-URL + webhook	Binnenkort beschikbaar	Binnenkort beschikbaar
Uw huisstijl	Bij daarvoor in aanmerking komende abonnementen	Bij daarvoor in aanmerking komende abonnementen	Binnenkort beschikbaar
Werkt nu al	Ja	Ja	Nee

Vragen

Veelgestelde vragen over de SDK en de widget.

Begin met bouwen

De gehoste pagina is de snelste manier om te beginnen.

Eén API-aanroep, één link, geen SDK nodig. Probeer het vandaag nog met een sandbox-sleutel.

Gratis starten in de sandbox API-referentie