Saltar al contenido principal
ShieldID

Desarrolladores

Documentación de la API de verificación de identidad, hecha para usarse de verdad.

Una API REST, una página alojada para las partes que no desea construir y webhooks firmados para enterarse en el instante en que hay un resultado. Las claves del entorno de pruebas (sandbox) nunca se facturan, así que la forma más rápida de entender ShieldID es llamarlo.

Comience gratis en el entorno de pruebas (sandbox)Lea la guía de inicio rápido

La versión de cinco minutos

Cuatro llamadas. Un solo modelo mental.

Todo lo demás en esta documentación es detalle sobre este ciclo.

  1. Cree una sesión

    POST /v1/sessions con una URL de retorno y una URL de webhook. Usted recibe un session_id y una verification_url.

  2. Entréguelo al solicitante

    Envíe la verification_url como enlace, o deje que escaneen el código QR que la página alojada muestra en la computadora. Ellos terminan en su propio teléfono.

  3. Reciba un webhook firmado

    Cuando la sesión llega a VERIFIED o FAILED, ShieldID envía el resultado mediante POST a la URL de su webhook, firmado para que usted pueda confiar en que proviene de nosotros.

  4. Lea el resultado

    Confíe en el webhook, o llame usted mismo a GET /v1/sessions/{id}/result. De cualquier modo obtiene veredictos por cada verificación, no una sola puntuación opaca.

Pruébelo

Cree su primera sesión.

La misma solicitud en tres lenguajes. Esta es la llamada que describe el primer paso del modelo mental.

bash
# Create a verification session (sandbox keys are never billed)
curl -X POST https://api.shieldid.ca/v1/sessions \
  -H "X-Api-Key: vk_sand_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "return_url": "https://yourapp.example/verified",
    "webhook_url": "https://yourapp.example/hooks/shieldid"
  }'

# → { "session_id": "…", "verification_url": "https://…/v/…", "environment": "sandbox" }

Las claves del entorno de pruebas (sandbox), vk_sand_…, ejecutan este mismo flujo sin costo. Cambie a una clave vk_live_ y no cambia nada más, salvo la factura.

Encuentre su camino

El resto de la documentación para desarrolladores.

Seis páginas. Lea las que necesite.

Inicio rápido

De la clave del entorno de pruebas (sandbox) al primer webhook firmado, en orden.
Abrir Inicio rápido

SDKs

El widget web, el flujo alojado y lo que viene.
Abrir SDKs

Estado

Sobre qué informaremos, una vez que la fuente de datos esté activa.
Abrir Estado

Entorno de pruebas

Pruebe todo el flujo antes de firmar nada.

Una clave del entorno de pruebas (sandbox), con prefijo vk_sand_, ejecuta la misma API, la misma página alojada y el mismo flujo de webhook que producción. Las sesiones se marcan con environment: "sandbox" dondequiera que aparecen, y las sesiones de sandbox nunca se facturan, en ningún plan.

Lea la guía del entorno de pruebas (sandbox)
  • Cree sesiones reales, verifique un documento real en su propio teléfono y reciba de vuelta un webhook firmado real
  • Nada de lo que haga en sandbox afecta una factura
  • Pase a producción cambiando el prefijo de la clave; la estructura de la solicitud no cambia

Construido a la vista de todos

Qué está terminado y qué aún no.

Preferimos decírselo a que lo descubra en plena integración.

Funciones de retrollamada de finalización del widget web

Próximamente

onComplete, onCancel y onStep existen hoy en la interfaz del widget, pero todavía nada los dispara. Use la URL de retorno y el webhook: ambos funcionan ahora.

Límites de tasa aplicados

Próximamente

Cada clave de API tiene un límite de tasa registrado según su plan, pero aún no se aplica a las solicitudes; planifique en consecuencia y no cuente con que ShieldID limite su tráfico.

Registro de autoservicio para el entorno de pruebas (sandbox)

Próximamente

Las claves del entorno de pruebas (sandbox) se emiten bajo solicitud mientras se desarrolla el registro de autoservicio. Solicítela y se la entregaremos con rapidez.

Preguntas

Respuestas directas para desarrolladores.

Comience ahora

Póngalo en producción en una tarde.

Comience con una clave del entorno de pruebas (sandbox), ejecute una verificación en su propio teléfono y lea el webhook que le envía. No se requiere llamada de ventas.

Comience gratis en el entorno de pruebas (sandbox)Lea la guía de inicio rápido

Las sesiones en el entorno de pruebas (sandbox) nunca se facturan.