Czy użyć strony hostowanej, czy widżetu?

Proszę zacząć od strony hostowanej — wymaga jednego wywołania API i żadnego kodu po stronie klienta. Po widżet warto sięgnąć tylko wtedy, gdy pozostawienie wnioskodawcy w Państwa układzie strony jest na tyle ważne, by podjąć się integracji przez iframe i zaakceptować obecne ograniczenia callbacków.

Dlaczego callbacki onComplete i onCancel widżetu nie są wywoływane?

Hostowana strona wewnątrz iframe nie wysyła jeszcze komunikatów, na które nasłuchuje widżet. To znana luka, a nie błąd konfiguracji po Państwa stronie. Do czasu jej usunięcia proszę korzystać z return_url i webhooka, które oba działają już dziś.

Czy można bezpiecznie umieścić klucz API w wywołaniu init() widżetu?

Technicznie widżet to przyjmuje, ale tego nie zalecamy: surowy klucz w kodzie JavaScript po stronie klienta jest widoczny dla każdego, kto wyświetli źródło strony. Proszę utworzyć sesję po stronie serwera i przekazać widżetowi uzyskany verification_url.

Czy istnieje komponent React lub mobilny?

Jeszcze nie. Widżet webowy to dziś zwykły znacznik script; natywne SDK dla iOS i Androida są planowane. W międzyczasie strona hostowana działa w WebView lub przeglądarce systemowej.

Czy widżet obsługuje język francuski?

Tak — proszę przekazać locale: "fr" tak samo jak w API, a przepływ wewnątrz iframe zostanie wyświetlony po francusku.

SDKs

SDK do weryfikacji tożsamości i ścieżka bez SDK.

Większość integracji w ogóle nie potrzebuje SDK — pracę wykonuje strona hostowana. Widżet webowy jest dostępny wtedy, gdy przepływ ma pozostać wewnątrz Państwa własnej strony. Natywne SDK mobilne są następne.

Przeczytaj krótki przewodnik Dokumentacja API

Ścieżka bez SDK

Strona hostowana nie wymaga SDK, na żadnej platformie.

POST /v1/sessions zwraca verification_url. Proszę wysłać go wnioskodawcy w dowolny sposób, w jaki Państwa produkt już wysyła linki — e-mailem, SMS-em, przekierowaniem w aplikacji, kodem QR na ekranie — a ShieldID zajmie się przechwyceniem dokumentu, testem żywotności i selfie na telefonie wnioskodawcy.

Działa z aplikacji webowej, z przeglądarki systemowej lub WebView aplikacji natywnej, z linku w e-mailu albo z kodu QR w kiosku — nic nie trzeba instalować
Branding white-label w kwalifikujących się planach, aby całość nie wyglądała jak przekazanie użytkownika stronie trzeciej
Wyniki docierają do Państwa przez przekierowanie return_url i podpisany webhook — nie jest wymagana obsługa callbacków po stronie klienta

Punkt końcowy strony hostowanej

Widżet webowy

Niewielki skrypt, który renderuje hostowany przepływ weryfikacji w iframe na Państwa stronie, zamiast odsyłać wnioskodawcę poza nią.

Co działa już dziś

TLVerify.init({ apiKey, containerId, returnUrl, cancelUrl, webhookUrl, locale, theme }) tworzy sesję i montuje ją w wybranym przez Państwa elemencie
Uruchamia identyczny przepływ przechwytywania jak strona hostowana, w Państwa układzie strony, z Państwa accentColor i logo
Już dziś działa w zakresie tworzenia sesji i wyświetlania przepływu bezpośrednio na stronie

Wywołania zwrotne po zakończeniu

Wkrótce

onComplete, onCancel, onStep oraz automatyczna zmiana rozmiaru iframe są częścią interfejsu widżetu, ale nic w przepływie jeszcze ich nie wywołuje. Proszę nie budować logiki zależnej od ich wywołania — zamiast tego proszę użyć adresu URL powrotu i webhooka, które działają już dziś.

Uwaga o kluczach API w przeglądarce

Wywołanie init() widżetu jest udokumentowane jako przyjmujące surowy apiKey w kodzie JavaScript po stronie klienta. Nie zalecamy tego w środowisku produkcyjnym: każdy, kto wyświetli źródło strony, zobaczy Państwa klucz. Zamiast tego proszę utworzyć sesję na backendzie za pomocą POST /v1/sessions i przekazać widżetowi uzyskany verification_url do wyświetlenia — to samo zalecenie co w przypadku strony hostowanej, tylko osadzone zamiast podlinkowanego.

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>

Mobilne

Natywne SDK już wkrótce.

Obecnie nie ma SDK dla iOS ani Androida. Do tego czasu proszę otworzyć hostowaną stronę weryfikacji w przeglądarce systemowej lub w WebView wewnątrz Państwa aplikacji — to ten sam przepływ, który widzi wnioskodawca korzystający z przeglądarki, i działa już teraz, na każdej platformie, na której działa Państwa aplikacja.

WkrótceNatywne SDK dla iOS i Androida

Wybór ścieżki

Trzy drogi, porównane uczciwie.

Proszę zacząć od strony hostowanej, chyba że mają Państwo konkretny powód, by osadzać.

Co daje każda ścieżka integracji już dziś.
Funkcja	Strona hostowana	Widżet webowy	SDK mobilne
Bez SDK, bez kodu po stronie klienta	Tak	Nie	Wkrótce
Pozostaje na Państwa własnej stronie	Otwiera się jako link	Osadzony iframe	Wkrótce
Callbacki ukończenia w Państwa kodzie	URL powrotu + webhook	Wkrótce	Wkrótce
Państwa branding	W kwalifikujących się planach	W kwalifikujących się planach	Wkrótce
Działa już dziś	Tak	Tak	Nie

Pytania

FAQ do SDK i widżetu.

Rozpoczęcie pracy

Strona hostowana to najszybsza droga.

Jedno wywołanie API, jeden link, bez konieczności użycia SDK. Proszę wypróbować już dziś z kluczem sandbox.

Zacznij za darmo w sandboksie Dokumentacja API