Webhooks

Cuando se activa una regla de prevención de fraude, SmartID envía una solicitud a un endpoint REST alojado por tu organización. Debes crear y exponer este servicio web para recibir y procesar estas solicitudes de acción.

Payload de Solicitud

SmartID envía una solicitud POST con el siguiente payload JSON a tu endpoint de webhook.

Atributos

action integer required

Acción a ejecutar. Acciones por defecto:

1 = Bloquear usuario
2 = Cerrar sesión
3 = Enviar correo
4 = Enviar SMS
5 = Enviar correo y SMS

Estas son las acciones por defecto. Se pueden definir acciones personalizadas a partir de 6 en adelante.

channel integer required

Identificador del canal.

date datetime required

Fecha y hora cuando se activó la regla (formato ISO 8601).

message string required

Mensaje a enviar al usuario, o una plantilla HTML.

reason integer required

Identificador de la regla que fue activada.

session string required

Identificador de sesión.

client string required

Identificador de usuario hasheado.

clientRSA string optional

Identificador de usuario cifrado con RSA.

Tu Endpoint de Webhook

POST https://your-domain.com/smartid/webhook

Header: Authorization: Bearer <license_key>

Tu endpoint de webhook debe validar el token Bearer incluido en cada solicitud de SmartID.

JSON — Request

{
  "action": 4,
  "channel": 1,
  "date": "2021-07-28T09:13:35",
  "message": "Login from a new device detected",
  "reason": 12,
  "session": "nmunx32$dsafnwu",
  "client": "bb4e31eedfecacc00cb6...",
  "clientRSA": "g4IRqSFWtn54tIEtrJkA3..."
}

Respuesta Esperada

Tu servicio debe devolver la siguiente respuesta JSON:

code integer required

1 = Acción ejecutada exitosamente, 0 = Acción no ejecutada.

message string optional

Descripción opcional del resultado o error.

JSON — Response

{
  "code": 1,
  "message": "Action executed successfully"
}