Referência de API

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

Todos os pedidos requerem a sua chave API no cabeçalho Authorization.

Criar token de portal

Cria um token de portal JWT para inicializar o FaceGuard no seu frontend.

POST /faceguard/session/portal

Pedido

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"
    }
}'

Corpo do pedido

Campo	Tipo	Obrigatório	Descrição
workflow_id	string	Sim	O seu ID de fluxo de trabalho FaceGuard do painel
customer	object	Sim	Dados do cliente (ver abaixo)

Objeto customer

Campo	Tipo	Obrigatório	Descrição
customer_id	string	Sim	O seu identificador único para o utilizador
email	string	Não	Email do utilizador
first_name	string	Não	Primeiro nome do utilizador
last_name	string	Não	Apelido do utilizador

Resposta

Resposta

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

Passe o token ao seu frontend (SDK, URL do iframe ou URL do WebView). Os tokens de portal expiram ao fim de 30 minutos.

---

Endpoints de sessão

Estes endpoints são usados internamente pela app FaceGuard. Estão documentados aqui como referência, mas não são chamados diretamente pelos integradores.

Criar sessão

Cria uma sessão FaceGuard a partir de um token de portal. Chamado automaticamente quando o FaceGuard é carregado.

POST /faceguard/session
Authorization: Bearer PORTAL_TOKEN

Obter estado da sessão

Consulta o estado mais recente da sessão usando o token de portal. Usado pelo fluxo de código QR para detetar quando o utilizador móvel completa a verificação.

GET /faceguard/session/status
Authorization: Bearer PORTAL_TOKEN

---

Endpoints de código curto

Usados pelo fluxo de código QR para transferência para o telemóvel.

Método	Caminho	Auth	Descrição
POST	/faceguard/short-code	Portal JWT	Criar um código curto
PUT	/faceguard/short-code	Portal JWT	Atualizar um código curto
GET	/faceguard/short-code?code=ABC123	Público	Resgatar um código curto

Envelope de resposta

Todas as respostas usam o envelope padrão da Surt:

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