Developers

API Reference

REST API structure for orchestrating biometric verification sessions in production integrations.

Base URL

https://api.hidglobal.example/v1

Authentication

All requests require a bearer token in the Authorization header.

POST/verify/start

Initialize a verification session and receive a client token.

Request

curl -X POST https://api.hidglobal.example/v1/verify/start \
  -H "Authorization: Bearer <server-token>" \
  -H "Content-Type: application/json" \
  -d '{"applicant_id":"app_8h2k","redirect_url":"https://example.com/done"}'

Response

{
  "session_id": "HGB-2026-X82J91",
  "client_token": "client_token_••••",
  "expires_at": "2026-06-27T12:30:00Z"
}

POST/verify/liveness

Submit passive liveness signals for the active session.

Request

curl -X POST https://api.hidglobal.example/v1/verify/liveness \
  -H "Authorization: Bearer <server-token>" \
  -d '{"session_id":"HGB-2026-X82J91","signals":{"blink":true,"yaw":12}}'

Response

{
  "session_id": "HGB-2026-X82J91",
  "liveness": "passed",
  "score": 0.987
}

POST/verify/complete

Finalize the verification and trigger downstream webhooks.

Request

curl -X POST https://api.hidglobal.example/v1/verify/complete \
  -H "Authorization: Bearer <server-token>" \
  -d '{"session_id":"HGB-2026-X82J91"}'

Response

{
  "session_id": "HGB-2026-X82J91",
  "status": "verified",
  "face_match": 99.4,
  "confidence": 99.7,
  "risk": "low"
}

GET/status

Fetch the current status of a verification session.

Request

curl https://api.hidglobal.example/v1/status?session_id=HGB-2026-X82J91 \
  -H "Authorization: Bearer <server-token>"

Response

{
  "session_id": "HGB-2026-X82J91",
  "status": "verified",
  "verified_at": "2026-06-27T12:24:18Z"
}