Overview

When to use it

eKYC Core is a collection of single-purpose, HMAC-signed endpoints — document scanning, tamper detection, liveness, face match, NFC chip verification, and more — that you compose yourself into a full identity-verification flow. Reach for it when you need to orchestrate your own sequence of checks, run a single check in isolation, or plug a check into a step of a journey you already control. Reach for eKYC Platform instead when a ready-made, pre-configured onboarding journey is enough.

How it works

Every call is signed the same way and answers in the same JSON envelope, regardless of which check you're running:

  1. Sign the request. See Authentication mechanism for how the HMAC signature is generated and attached.
  2. Call the endpoints you need, in whatever order your flow requires — nothing beyond an individual endpoint's own inputs is enforced. See API Call Flow for a worked example end to end.
  3. Read the result from each endpoint's own response, using Common objects & errors for the request/response shapes and failure codes shared across the surface.

Integrating