SDKs
ID-verifierings-SDK och vägen utan SDK.
De flesta integrationer behöver ingen SDK alls – den hostade sidan gör jobbet. Webbwidgeten finns för när flödet ska stanna på din egen sida. Native SDKs för mobil kommer härnäst.
Vägen utan SDK
Den hostade sidan kräver ingen SDK, på någon plattform.
POST /v1/sessions returnerar en verification_url. Skicka den till den sökande på det sätt som din produkt redan skickar länkar – e-post, SMS, en omdirigering i appen, en QR-kod på en skärm – så sköter ShieldID fotograferingen, liveness-kontrollen och selfien på den sökandes egen mobil.
- Fungerar från en webbapp, en native apps systemwebbläsare eller WebView, en e-postlänk eller en QR-kod på en kiosk – inget att installera
- White label-profilering på kvalificerande planer, så att det inte ser ut som en överlämning till en tredje part
- Resultat når dig via omdirigeringen till return_url och den signerade webhooken – ingen koppling av callbacks på klientsidan behövs
Webbwidgeten
Bädda in flödet på din egen sida.
Ett litet skript som renderar det hostade verifieringsflödet i en iframe på din sida, i stället för att skicka iväg den sökande från den.
Vad som fungerar idag
- TLVerify.init({ apiKey, containerId, returnUrl, cancelUrl, webhookUrl, locale, theme }) skapar en session och monterar den i ett element som du väljer
- Kör exakt samma flöde för fotografering som den hostade sidan, inom din layout, med din accentColor och logotyp
- Fungerar i dag för att skapa en session och visa flödet inbäddat
Callbacks vid slutförande
Kommer snartonComplete, onCancel, onStep och automatisk storleksanpassning av iframe ingår i widgetens gränssnitt, men inget i flödet utlöser dem ännu. Bygg ingen logik som förutsätter att de aktiveras – använd return URL och webhook i stället, som båda fungerar redan idag.
En anmärkning om API-nycklar i webbläsaren
Widgetens egna init()-anrop är dokumenterat så att det accepterar en rå apiKey i JavaScript på klientsidan. Vi rekommenderar inte det i produktion: den som visar källkoden får tag i din nyckel. Skapa i stället sessionen på din backend med POST /v1/sessions och ge widgeten den resulterande verification_url att visa – samma rekommendation som för det hostade flödet, fast inbäddat i stället för länkat.
<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>Mobil
Native SDKs kommer.
Det finns ingen iOS- eller Android-SDK idag. Tills det finns en kan du öppna den hostade verifieringssidan i appens systemwebbläsare eller i en WebView – det är samma flöde som en sökande på webben får, och det fungerar nu, på alla plattformar som din app körs på.
Kommer snartNative SDKs för iOS och Android
Välja väg
Tre sätt att komma igång, ärligt jämförda.
Börja med den hostade sidan om du inte har en särskild anledning att bädda in.
| Funktion | Hostad sida | Webbwidget | Mobil-SDK |
|---|---|---|---|
| Ingen SDK, ingen kod på klientsidan | Ja | Nej | Kommer snart |
| Stannar på din egen sida | Öppnas som en länk | Inbäddad iframe | Kommer snart |
| Callbacks vid slutförande i din kod | Return URL + webhook | Kommer snart | Kommer snart |
| Din egen profilering | På kvalificerande abonnemang | På kvalificerande abonnemang | Kommer snart |
| Fungerar idag | Ja | Ja | Nej |
Frågor
Vanliga frågor om SDK och widget.
Börja bygga
Den hostade sidan är det snabbaste sättet att komma igång.
Ett API-anrop, en länk, ingen SDK krävs. Prova med en sandbox-nyckel redan idag.