SDKs
El SDK de verificación de identidad, y la ruta sin SDK.
La mayoría de las integraciones no necesita ningún SDK: la página alojada hace el trabajo. El widget web está disponible cuando desea que el flujo permanezca dentro de su propia página. Los SDKs móviles nativos son lo siguiente.
La vía sin SDK
La página alojada no requiere SDK, en ninguna plataforma.
POST /v1/sessions devuelve una verification_url. Envíela al solicitante de la manera en que su producto ya envía enlaces (correo electrónico, SMS, una redirección dentro de la app, un código QR en una pantalla) y ShieldID se encarga de la captura, el desafío de prueba de vida y la selfie en su propio teléfono.
- Funciona desde una aplicación web, el navegador del sistema o el WebView de una app nativa, un enlace de correo electrónico o un código QR en un quiosco; no hay nada que instalar
- Marca blanca en los planes que califiquen, para que no parezca una transferencia a un tercero
- Los resultados le llegan mediante la redirección return_url y el webhook firmado; no se necesita configurar callbacks del lado del cliente
El widget web
Integre el flujo en su propia página.
Un pequeño script que muestra el flujo de verificación alojado dentro de un iframe en su página, en lugar de enviar al solicitante fuera de ella.
Lo que funciona hoy
- TLVerify.init({ apiKey, containerId, returnUrl, cancelUrl, webhookUrl, locale, theme }) crea una sesión y la monta en el elemento que usted elija
- Ejecuta el mismo flujo de captura que la página alojada, dentro de su diseño, con su accentColor y su logotipo
- Funciona hoy para crear una sesión y mostrar el flujo integrado en la página
Callbacks de finalización
PróximamenteonComplete, onCancel, onStep y el ajuste automático del tamaño del iframe forman parte de la interfaz del widget, pero por ahora nada dentro del flujo los activa. No construya lógica que dependa de que se disparen; use en su lugar la URL de retorno y el webhook, que funcionan hoy.
Una nota sobre las claves de API en el navegador
La llamada init() del propio widget está documentada para aceptar una apiKey sin protección en JavaScript del lado del cliente. No lo recomendamos en producción: cualquiera que vea el código fuente obtiene su clave. En su lugar, cree la sesión en su backend con POST /v1/sessions y pásele al widget la verification_url resultante para que la muestre; es la misma recomendación que para el flujo alojado, solo que integrado en lugar de enlazado.
<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>Móvil
Los SDKs nativos están en camino.
Hoy no existe un SDK para iOS ni Android. Mientras tanto, abra la página de verificación alojada dentro del navegador del sistema de su app o de un WebView; es el mismo flujo que recibe un solicitante en la web y funciona ahora, en cualquier plataforma donde se ejecute su app.
PróximamenteSDKs nativos para iOS y Android
Cómo elegir una vía
Tres formas de integrarse, comparadas con honestidad.
Comience con la página alojada, a menos que tenga una razón específica para integrar el flujo.
| Capacidad | Página alojada | Widget web | SDK móvil |
|---|---|---|---|
| Sin SDK ni código del lado del cliente | Sí | No | Próximamente |
| Permanece dentro de su propia página | Se abre como un enlace | iframe integrado | Próximamente |
| Callbacks de finalización en su código | URL de retorno + webhook | Próximamente | Próximamente |
| Su marca | En los planes que califiquen | En los planes que califiquen | Próximamente |
| Funciona hoy | Sí | Sí | No |
Preguntas
Preguntas frecuentes del SDK y del widget.
Comience a construir
La página alojada es la forma más rápida de comenzar.
Una llamada a la API, un enlace, sin SDK. Pruébelo hoy mismo con una clave del entorno de pruebas (sandbox).