Hosted page ba o widget ang dapat kong gamitin?

Magsimula sa hosted page — isang API call lang ang kailangan at walang client-side code. Gamitin lang ang widget kung sapat na mahalaga sa iyo na manatili ang applicant sa sarili mong layout para tanggapin ang isang iframe integration at ang kasalukuyang limitasyon ng callback.

Bakit hindi nagfi-fire ang mga callback na onComplete at onCancel ng widget?

Hindi pa nagpapadala ang hosted page sa loob ng iframe ng mga mensaheng pinakikinggan ng widget. Isa itong kilalang puwang, hindi pagkakamali sa configuration mo. Gamitin ang return_url at ang webhook, na parehong gumagana ngayon, hanggang maayos ito.

Ligtas ba na ilagay ang aking API key sa init() call ng widget?

Teknikal na tinatanggap ito ng widget, pero hindi namin ito inirerekomenda: ang raw na key sa client-side JavaScript ay makikita ng sinumang mag-view ng source. Likhain ang session sa server-side at ibigay sa widget ang nagresultang verification_url.

May React o mobile component ba?

Wala pa. Isang simpleng script tag ang web widget ngayon; plano pa lang ang mga native na iOS at Android SDK. Samantala, gumagana ang hosted page sa loob ng WebView o system browser.

Sinusuportahan ba ng widget ang French?

Oo — ipasa ang locale: "fr" gaya ng gagawin mo sa API, at lalabas sa French ang flow sa loob ng iframe.

SDKs

Ang ID verification SDK, at ang zero-SDK na landas.

Karamihan ng integration ay hindi na nangangailangan ng SDK — ang hosted page na ang gumagawa ng trabaho. Narito ang web widget kapag gusto mong manatili ang flow sa loob ng sarili mong page. Susunod ang mga native mobile SDK.

Basahin ang quickstart API reference

Ang zero-SDK na landas

Hindi kailangan ng SDK ng hosted page, sa anumang platform.

Nagbabalik ang POST /v1/sessions ng verification_url. Ipadala ito sa applicant sa anumang paraang ginagamit na ng product mo sa pagpapadala ng link — email, SMS, in-app redirect, QR code sa screen — at ang ShieldID na ang bahala sa capture, liveness challenge at selfie sa sarili nilang phone.

Gumagana mula sa web app, system browser o WebView ng native app, email link, o QR code sa kiosk — walang kailangang i-install
White-label branding sa mga qualifying plan, para hindi magmukhang hand-off sa third party
Dumarating sa iyo ang mga resulta sa pamamagitan ng return_url redirect at ng naka-sign na webhook — hindi na kailangan ng client-side callback wiring

Tingnan ang hosted-page endpoint

Ang web widget

Isang maliit na script na nagre-render ng hosted verification flow sa loob ng iframe sa iyong page, sa halip na ilayo ang applicant mula rito.

Ano ang gumagana ngayon

TLVerify.init({ apiKey, containerId, returnUrl, cancelUrl, webhookUrl, locale, theme }) ay gumagawa ng session at ini-mount ito sa elementong pipiliin mo
Tumatakbo ang parehong capture flow gaya ng hosted page, sa loob ng iyong layout, gamit ang iyong accentColor at logo
Gumagana na ngayon para sa paggawa ng session at pagpapakita ng flow nang inline

Mga completion callback

Malapit na

Ang onComplete, onCancel, onStep at awtomatikong pag-resize ng iframe ay bahagi ng interface ng widget, pero wala pang nagti-trigger sa mga ito sa loob ng flow. Huwag gumawa ng logic na nakasalalay sa pag-fire ng mga ito — gamitin na lang ang return URL at ang webhook, na parehong gumagana ngayon.

Paalala tungkol sa mga API key sa browser

Naka-document na tumatanggap ang init() call ng widget ng raw na apiKey sa client-side JavaScript. Hindi namin ito inirerekomenda sa production: sinumang mag-view ng source ay makukuha ang iyong key. Sa halip, likhain ang session sa iyong backend gamit ang POST /v1/sessions, at ibigay sa widget ang nagresultang verification_url para i-render — kapareho ng rekomendasyon para sa hosted flow, pero naka-embed sa halip na link.

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>

Mobile

Parating na ang mga native SDK.

Wala pang iOS o Android SDK ngayon. Hanggang sa magkaroon nito, buksan ang hosted verification page sa system browser o WebView ng iyong app — ito ang parehong flow na natatanggap ng web applicant, at gumagana na ito ngayon sa anumang platform na pinagtatakbuhan ng iyong app.

Malapit naMga native na iOS at Android SDK

Pagpili ng paraan

Tatlong paraan ng pagsisimula, tapat na paghahambing.

Magsimula sa hosted page maliban kung mayroon kang partikular na dahilan para mag-embed.

Ang makukuha mo ngayon sa bawat integration path.
Kakayahan	Hosted page	Web widget	Mobile SDK
Walang SDK, walang client-side code	Oo	Hindi	Malapit na
Nananatili sa loob ng sarili mong page	Nagbubukas bilang link	Naka-embed na iframe	Malapit na
Mga completion callback sa iyong code	Return URL + webhook	Malapit na	Malapit na
Iyong branding	Sa mga kwalipikadong plan	Sa mga kwalipikadong plan	Malapit na
Gumagana ngayon	Oo	Oo	Hindi

Mga Tanong

FAQ ng SDK at widget.

Simulan ang pag-build

Ang hosted page ang pinakamabilis na paraan para magsimula.

Isang API call, isang link, walang kailangang SDK. Subukan ito ngayon gamit ang sandbox key.

Magsimula nang libre sa sandbox API reference