Skip to main content

Iframe Configuration

Customize the iframe appearance and behavior via query parameters or the API configuration endpoint.

Query parameters​

ParameterTypeDefaultDescription
tokenstring—Required. Session token
localestringenUI language (en, es, de, fr)
themestringlightColor theme (light, dark, auto)
hideHeaderbooleanfalseHide the Heuristik header bar
primaryColorstring#317ee8Brand primary color (hex)

Example URL​

https://verify.heuristik.com?token=SESSION_TOKEN&locale=es&theme=dark&primaryColor=%23317ee8

API configuration​

You can also set defaults via the Configuration API:

PUT /configuration
{
"webhookUrl": "https://yourapp.com/webhooks/heuristik",
"allowedOrigins": [
"https://yourapp.com",
"https://staging.yourapp.com"
],
"riskThreshold": 75,
"enabledModules": ["fingerprint", "liveness"]
}
Same request in YAML format (for reference)
webhookUrl: https://yourapp.com/webhooks/heuristik
allowedOrigins:
- https://yourapp.com
- https://staging.yourapp.com
riskThreshold: 75
enabledModules:
- fingerprint
- liveness

Webhook events​

EventDescription
session.completedVerification finished successfully
session.expiredSession expired before completion
fingerprint.collectedDevice fingerprint data collected
risk.flaggedRisk score exceeded threshold
Webhook security

All webhook payloads include an X-Heuristik-Signature header. Verify the signature using your webhook secret to ensure authenticity.