Neetix Liveliness API
The complete HTTP surface of the Neetix Liveliness API. Authentication. Most endpoints take a tenant API key as Authorization: Bearer (Basic is also accepted…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The complete HTTP surface of the Neetix Liveliness API.
Authentication. Most endpoints take a tenant API key asAuthorization: Bearer (Basic is also accepted for
Digitap-compatible callers). Console surfaces (links, reviews, settings,
workflows, AML monitoring, billing reads) additionally accept thelv_session cookie minted by Google sign-in — the cookie is used only when
no Authorization header is present, and cookie-authed mutations are
CSRF-guarded by an Origin/Referer check. /v1/admin/* uses a dedicated
operator key. A few endpoints are deliberately public (signup, leads,
hosted-link token endpoints, health probes).
Credits. Self-serve (DB-backed) keys are prepaid: each billable call
deducts the endpoint's credit cost from the tenant balance and fails with402 insufficient_credits when it cannot. Costs are listed per endpoint in
this document (e.g. face match = 2 credits). Enterprise/static config keys
are postpaid and exempt.
Errors. Failures use one JSON envelope (ErrorEnvelope) with a stablemessage_code. The face-match no-face/undecodable-image case returns a
Digitap-compatible 422 fail body instead.
Response signing. Face-match responses are signed with Ed25519 when
configured — the detached signature is in the X-Neetix-Signature header
and the public key at GET /v1/verification-key.
Endpoints 68
Health
- GETLiveness probe
/healthCheap liveness probe — the process is up and models are loaded. Public. - GETReadiness probe
/readyReadiness probe — additionally checks the database is reachable. Public. - GETPrometheus metrics
/metricsPrometheus text exposition — per (method, route, status) request counters, a latency histogram and an in-flight gauge. Requires an API key unless the… - GETHosted capture page
/captureA self-contained browser page that opens the camera, captures a selfie and posts it to /v1/liveness. Public. - GETResponse-signing public key
/v1/verification-keyThe Ed25519 public key used to sign face-match response bodies (detached signature in the X-Neetix-Signature header). Public.
Signup & Leads
- POSTSelf-serve trial signup
/v1/signupIssues a DB-backed trial API key with signup bonus credits. Public, per-IP rate limited (5 signups/hour). The raw key is returned once; only its hash is… - POSTEnterprise contact form
/v1/leadsStores an enterprise/sales lead and notifies the team in real time. Public, per-IP rate limited (10 submissions/hour). The hidden website field is a honeypot…
Console Auth
- GETIs Google sign-in configured?
/v1/auth/configLets the console decide whether to show the "Sign in with Google" button. Public. - GETBegin Google sign-in
/v1/auth/google/startSets the lv_oauth state/PKCE cookie and redirects (302) to Google's consent screen. 404 when Google sign-in is not configured. - GETGoogle OAuth callback
/v1/auth/google/callbackVerifies the state against the lv_oauth cookie, exchanges the code (PKCE), verifies the id_token via Google's tokeninfo endpoint (aud must match,… - POSTEnd the console session
/v1/auth/logoutDeletes the session row and clears the lv_session cookie. CSRF origin-checked. - GETSession identity and keys
/v1/auth/meThe signed-in user's email, tenant id and API keys (8-char hash prefixes — the ids POST /v1/keys/revoke accepts).
API Keys
- POSTMint an API key
/v1/keysSession-authed, CSRF origin-checked. A brand-new Google user gets a fresh tenant plus signup credits; an existing tenant gets an additional key for the SAME… - POSTRevoke an API key
/v1/keys/revokeDeactivates one of the caller's own keys by the 8-char hash prefix shown in GET /v1/auth/me. Session-authed, CSRF origin-checked.
Face Verification
- POSTFace match (selfie vs ID)
/v1/face/face-matchThe core verification — 1:1 face match, passive liveness, quality metrics, spectral forensics, capture-integrity signals and a 1:N gallery check (duplicate /… - POSTFace match (alias)
/v1/face/verifyFriendlier alias for POST /v1/face/face-match — same handler, same request and response. Cost: 2 credits. - POSTEnroll a face in the tenant gallery
/v1/face/enrollEmbeds the face and stores it under subject_id in the tenant's 1:N gallery; blocklisted entries flag future matches. Cost: 1 credit. - POSTSearch the tenant gallery (1:N)
/v1/face/searchEmbeds the query face and returns the closest enrolled subjects (best first), with a blocklist_hit flag when a blocklisted subject clears the match threshold.…
Liveness & Age
- POSTPassive liveness check
/v1/livenessSingle-selfie passive liveness plus face signals. Cost: 1 credit. - POSTFacial age estimation
/v1/ageSingle-selfie age bracket + midpoint estimate. On engines without an age module the bracket is unknown and the estimate null. Cost: 1 credit. - POSTEnroll a face for biometric authentication
/v1/auth/enrollRegisters a user's face (single face required, genuine capture enforced) for later POST /v1/auth/verify. Cost: 1 credit. - POSTAuthenticate a returning user by face
/v1/auth/verifyPassive liveness plus a 1:1 match against the user's enrolled face(s). Cost: 1 credit.
Sessions
- POSTStart an active-liveliness session
/v1/session/startIssues a randomized ordered challenge list (center, a shuffled head turn, then blink or a second turn). Sessions expire after 10 minutes. Free — the charge… - POSTVerify session challenge frames
/v1/session/:id/verifyUpload one frame per challenge as frame_0, frame_1, … The server checks each frame's head pose (or blink) against the requested challenge and runs passive…
Streams
- POSTStart a continuous-liveliness (V-CIP) session
/v1/stream/startIssues a session id, a randomized challenge script and the WebSocket URL to stream frames to. Cost: 5 credits (charged at start). Sessions expire after 10… - GETStream frames (WebSocket)
/v1/stream/:idWebSocket upgrade for the session minted by /v1/stream/start (single-use — the connection claims the session). Send JPEG frames as binary messages (max 3 MB…
Templates
- POSTCreate a revocable biometric template
/v1/template/protectEmbeds the face and projects it through a tenant-and-version-specific key into a non-invertible binary template (ISO/IEC 24745). Store the template instead of… - POSTCompare two protected templates
/v1/template/verifyHamming similarity + match decision. Templates from different key versions never match (revoked true). Cost: 1 credit.
Documents
- POSTParse and validate an MRZ
/v1/document/mrzParses a TD1 (3x30) or TD3 (2x44) machine-readable zone and validates all check digits. Cost: 1 credit. - POSTVerify a US/CA driver's license / state ID
/v1/document/idDecodes the PDF417 barcode on the card back, parses its AAMVA payload and derives expiry/age checks; the optional front (portrait side) gets a face-presence…
AML
- POSTOne-shot sanctions/PEP screen
/v1/aml/screenFuzzy-matches a name (optionally with DOB) against the loaded watchlist; hits come back best first. Cost: 1 credit. - GETList monitored subjects
/v1/aml/monitorThe tenant's monitored subjects, newest first. Accepts an API key or a console session. - POSTAdd a subject to ongoing monitoring
/v1/aml/monitorStores the subject and screens it immediately. Every later watchlist rescreen re-checks it; a clear-to-hit transition fires the tenant webhook… - DELETEStop monitoring a subject
/v1/aml/monitor/:id404 covers both an unknown id and another tenant's subject (no existence leak). Accepts an API key or a console session.
Validation
- POSTValidate Indian identity documents
/v1/validate/identityPer-field format + checksum validation for Aadhaar (Verhoeff), PAN, Voter ID and Driving License numbers. Aadhaar is echoed masked only — the raw number is… - POSTValidate email / phone
/v1/validate/contactEmail validation with disposable/role-based flags; phone normalization to E.164 with a mobile heuristic. Cost: 1 credit. - POSTValidate Indian business identifiers
/v1/kyb/validateGSTIN (with real GSTN check-digit validation), PAN and CIN format + field decoding. Cost: 2 credits.
Risk
- POSTTransaction monitoring (KYT)
/v1/txn/monitorRule-based monitoring over a transaction batch (high value, structuring, velocity, round-tripping) with tunable thresholds. Cost: 1 credit. - POSTScreen a crypto wallet address
/v1/wallet/screenExact, case-insensitive match against the provisioned blocklist (or an inline blocklist supplied with the request). Cost: 1 credit. - POSTDevice and IP fraud-risk analysis
/v1/device/analyzeScores device-integrity and network signals (emulator, root, tampering, virtual camera, VPN/proxy/Tor/datacenter IP) into a risk score, level and flags. Cost:…
Workflows
- POSTRun a multi-check workflow
/v1/workflow/runRuns the requested checks (liveness, face_match, mrz, aml, device) against the same engines the standalone endpoints use, then folds them into one… - GETList saved workflows
/v1/workflowsThe tenant's saved workflow configurations, newest first. Accepts an API key or a console session. - POSTSave a workflow configuration
/v1/workflowsValidates and stores a reusable configuration. config.checks must be a non-empty array of known check names; config.thresholds is an optional object. Names… - PUTUpdate a saved workflow
/v1/workflows/:idReplaces name + config. 404 covers both an unknown id and another tenant's workflow (no existence leak). - DELETEDelete a saved workflow
/v1/workflows/:idSame tenant-scoped 404 rule as update.
Hosted Links
- GETList verification links
/v1/linksThe tenant's links with status and result summary, newest first. Accepts an API key or a console session. - POSTMint a hosted verification link
/v1/linksCreates a single-use URL the end user opens in a browser to verify themselves. Free to mint — the face_match charge (2 credits) lands on the link owner when… - GETLink status (public)
/v1/links/:tokenStatus for the hosted verify page. No auth — the token is the capability; per-IP rate limited (30/hour). Says nothing about the link owner. - POSTComplete a verification link (public)
/v1/links/:token/verifyThe end user submits selfie + ID; the standard face-match pipeline runs and the LINK OWNER is charged (face_match, 2 credits). Single-use: completion is…
Reviews
- GETList the review queue
/v1/reviewsThe tenant's verifications whose stored verdict is review, newest first. Already-decided rows stay listed with their decision attached. Accepts an API key or… - POSTRecord a review decision
/v1/reviews/:request_id/decisionRecords approved | declined (case-insensitive, note capped at 500 chars) onto the stored verification and writes an explicit audit row. 404 covers unknown id,… - GETRetained capture image
/v1/reviews/:request_id/image/:kindThe retained (downscaled, max 640 px long edge) capture behind a review entry, as raw JPEG bytes. Exists only when the tenant had retain_images on at…
Settings
- GETRead tenant settings
/v1/settingsThe tenant's webhook + image-retention settings; defaults when never saved. Accepts an API key or a console session. - PUTUpdate tenant settings
/v1/settingsPartial update — absent fields keep their stored value; an EMPTY STRING clears webhook_url / webhook_secret back to the global config. retention_days must be…
Billing
- GETCredit balance
/v1/billing/balanceThe caller's prepaid credit balance. Accepts an API key or a console session (a session with no key yet sees an empty account). - GETCredit ledger
/v1/billing/ledgerThe caller's credit movements, newest first. Accepts an API key or a console session. - GETPurchasable credit packs
/v1/billing/packsThe configured top-up packs. Accepts an API key or a console session. - POSTStart a credit top-up
/v1/billing/topupCreates a Dodo Payments checkout session for a pack; the customer pays on the returned checkout_url. Credits are granted ONLY when the payment.succeeded… - POSTDodo Payments webhook
/v1/billing/webhook/dodoInbound webhook from Dodo Payments. Authenticated by the Standard-Webhooks HMAC signature headers (webhook-id, webhook-timestamp, webhook-signature) — NOT an…
Admin
- GETOperator overview
/v1/admin/overviewSignup/lead/spend aggregates and 30-day per-endpoint usage. Admin key required; 404 when no admin key is configured (the surface is hidden). - GETSignup accounts
/v1/admin/accountsPer-signup balance and usage, newest first. Admin key required. - GETCaptured leads
/v1/admin/leadsEnterprise leads captured by POST /v1/leads, newest first. Admin key required. - POSTGrant credits
/v1/admin/credits/grantManual credit grant to an existing tenant (ledger reason admin_grant). Grants to unknown tenants are refused. Admin key required. - POSTRescreen all monitored subjects
/v1/admin/aml/rescreenFREE rescreen of every monitored subject (all tenants) against the loaded watchlist. Clear-to-hit transitions fire the subject owner's webhook. Refused (400)… - POSTHot-reload the AML watchlist
/v1/admin/aml/reloadRe-reads the configured watchlist file and swaps the live list in place (no restart). When the fresh list is non-empty, every monitored subject is rescreened… - POSTPurge expired retained images
/v1/admin/images/purgeDeletes retained verification images past each tenant's retention window (30-day default for tenants that never saved settings). The opportunistic per-store…
Account
- GETExport account data (DSAR)
/v1/account/exportData-subject access request: returns the calling tenant's stored account data — profile, key metadata, billing ledger, verification log metadata — as JSON.… - POSTDelete account data (DSAR)
/v1/account/deleteData-subject deletion request: wipes biometric data, verification images and logs, and scrubs the account email. Financial records required for accounting are…
API details
- Base URL
https://liveliness.neetix.in- Authentication
- A bearer token in the Authorization header
An API key in the lv_session cookie
A bearer token in the Authorization header - Operations
- 68 operations on 63 pathsPOST 40GET 24PUT 2DELETE 2
- Main resources
- Admin 7Billing 5Console Auth 5Health 5Workflows 5AML 4Face Verification 4Hosted Links 4Liveness & Age 4Reviews 3
- Response formats
application/jsonimage/jpegtext/htmltext/plain- Webhooks
- 3 described
- Description format
- OpenAPI 3.1.0, API version
0.1.0 - Links
- OpenAPI document · Support
- Listed from
- Neetix's published OpenAPI description
How to test the Neetix Liveliness API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Neetix Liveliness API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Liveness probe” (GET /health), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Neetix Liveliness API?
The complete HTTP surface of the Neetix Liveliness API. Authentication. Most endpoints take a tenant API key as Authorization: Bearer (Basic is also accepted… It is listed under Identity & security and has 68 endpoints.
Who publishes the Neetix Liveliness API?
It is listed from Neetix's public API description (an OpenAPI document), not published by Neetix on Swastik Codes. Anyone who controls liveliness.neetix.in can claim the profile by adding a DNS TXT record.
What is the base URL of the Neetix Liveliness API?
Requests go to https://liveliness.neetix.in. Endpoint paths are added to this base URL.
How do I authenticate with the Neetix Liveliness API?
It accepts 3 methods: A bearer token in the Authorization header; an API key in the lv_session cookie; A bearer token in the Authorization header.
How many endpoints does the Neetix Liveliness API have?
68 operations on 63 paths (40 POST, 24 GET, 2 PUT, 2 DELETE). The largest groups are Admin, Billing, Console Auth, Health.
Is forking the Neetix Liveliness API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.