API-Referenz

Basis-URL: https://api.surt.com

Alle Anfragen erfordern Ihren API-Schlüssel im Authorization-Header.

Portal-Token erstellen

Erstellt einen JWT-Portal-Token zur Initialisierung von FaceGuard in Ihrem Frontend.

POST /faceguard/session/portal

Anfrage

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

Anfrage-Body

Feld	Typ	Erforderlich	Beschreibung
workflow_id	string	Ja	Ihre FaceGuard-Workflow-ID aus dem Dashboard
customer	object	Ja	Kundendaten (siehe unten)

Customer-Objekt

Feld	Typ	Erforderlich	Beschreibung
customer_id	string	Ja	Ihre eindeutige Kennung für den Nutzer
email	string	Nein	E-Mail des Nutzers
first_name	string	Nein	Vorname des Nutzers
last_name	string	Nein	Nachname des Nutzers

Antwort

Antwort

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

Übergeben Sie den token an Ihr Frontend (SDK, iframe-URL oder WebView-URL). Portal-Tokens laufen nach 30 Minuten ab.

---

Session-Endpunkte

Diese Endpunkte werden intern von der FaceGuard-App verwendet. Sie sind hier zur Referenz dokumentiert, werden aber nicht direkt von Integratoren aufgerufen.

Session erstellen

Erstellt eine FaceGuard-Session aus einem Portal-Token. Wird automatisch aufgerufen, wenn FaceGuard lädt.

POST /faceguard/session
Authorization: Bearer PORTAL_TOKEN

Session-Status abrufen

Fragt den neuesten Session-Status über den Portal-Token ab. Wird vom QR-Code-Flow verwendet, um zu erkennen, wenn der mobile Nutzer die Verifizierung abschließt.

GET /faceguard/session/status
Authorization: Bearer PORTAL_TOKEN

---

Shortcode-Endpunkte

Werden vom QR-Code-Flow für die Smartphone-Übergabe verwendet.

Methode	Pfad	Auth	Beschreibung
POST	/faceguard/short-code	Portal JWT	Shortcode erstellen
PUT	/faceguard/short-code	Portal JWT	Shortcode aktualisieren
GET	/faceguard/short-code?code=ABC123	Öffentlich	Shortcode einlösen

Antwort-Envelope

Alle Antworten verwenden den Standard-Surt-Envelope:

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