API

Developer API documentation

Integrate HECID verification into your own application using our REST API.

Base URL

https://hecid.com/v1/

Authentication

All endpoints require a Bearer token from Keycloak. Obtain via password grant:

POST /auth/realms/hecid/protocol/openid-connect/token
Content-Type: application/x-www-form-urlencoded

grant_type=password&client_id=hecid-mobile&username=EMAIL&password=PASS&scope=openid

Key endpoints

  • POST /v1/verification-sessions — Create a verification session (requires Idempotency-Key header)
  • GET /v1/verification-sessions/{id} — Get session status
  • POST /v1/verification-sessions/{id}/captures — Upload document/selfie (multipart)
  • POST /v1/verification-sessions/{id}/submit — Submit for review
  • GET /v1/tenant/workflows — List available workflows
  • POST /v1/auth/register — Create a new account
  • POST /v1/auth/forgot-password — Request password reset

OpenAPI spec

Full OpenAPI 3.0 specification available in the repository under code/openapi/.

Developer portal

For interactive API exploration, visit the Developer portal.