Referencia de API

URL base: https://api.surt.com

Todas las solicitudes requieren tu clave API en el encabezado Authorization.

Crear token de portal

Crea un token de portal JWT para inicializar FaceGuard en tu frontend.

POST /faceguard/session/portal

Solicitud

cURL

curl --location 'https://api.surt.com/faceguard/session/portal' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "workflow_id": "YOUR_WORKFLOW_ID",
    "customer": {
        "customer_id": "user_123",
        "email": "customer@example.com",
        "first_name": "John",
        "last_name": "Doe"
    }
}'

Cuerpo de la solicitud

Campo	Tipo	Requerido	Descripción
workflow_id	string	Sí	Tu ID de flujo de trabajo FaceGuard del panel
customer	object	Sí	Datos del cliente (ver abajo)

Objeto customer

Campo	Tipo	Requerido	Descripción
customer_id	string	Sí	Tu identificador único para el usuario
email	string	No	Email del usuario
first_name	string	No	Nombre del usuario
last_name	string	No	Apellido del usuario

Respuesta

Respuesta

{
  "status_code": 200,
  "message": "Portal token created",
  "data": {
    "token": "eyJ0eXAiOiJKV1Qi...",
    "customer_id": "user_123"
  }
}

Pasa el token a tu frontend (SDK, URL del iframe o URL del WebView). Los tokens de portal expiran a los 30 minutos.

---

Endpoints de sesión

Estos endpoints son usados internamente por la app FaceGuard. Están documentados aquí como referencia, pero los integradores no los llaman directamente.

Crear sesión

Crea una sesión FaceGuard a partir de un token de portal. Se llama automáticamente cuando FaceGuard se carga.

POST /faceguard/session
Authorization: Bearer PORTAL_TOKEN

Obtener estado de sesión

Consulta el último estado de la sesión usando el token de portal. Usado por el flujo de código QR para detectar cuándo el usuario móvil completa la verificación.

GET /faceguard/session/status
Authorization: Bearer PORTAL_TOKEN

---

Endpoints de código corto

Usados por el flujo de código QR para la transferencia al teléfono.

Método	Ruta	Auth	Descripción
POST	/faceguard/short-code	Portal JWT	Crear un código corto
PUT	/faceguard/short-code	Portal JWT	Actualizar un código corto
GET	/faceguard/short-code?code=ABC123	Público	Canjear un código corto

Envelope de respuesta

Todas las respuestas usan el envelope estándar de Surt:

{
  "status_code": 200,
  "message": "Success",
  "data": { ... }
}