Documentation

Integrate OKIAS identity verification

OKIAS is a developer-first AI KYC/IDV API: document checks, active liveness, 1:1 face match and sanctions screening behind a single REST endpoint. This guide takes you from your first API key to production — plus everything you need to run the partner and reseller programs.

Every request goes to https://api.okias.io/v1. Authenticate with a secret key, create a verification, then read the result over a signed webhook. No SDK required — call the REST API directly in any language.

Base URL
Use https://api.okias.io/v1 — every example in these docs is runnable against it.okias.io/v1 also still works and is not deprecated, so an integration written before the dedicated host existed keeps running unchanged.
New here? Start with the Quickstart.
The Quickstart walks you through signing up, getting a key and verifying a real user end to end — about five minutes. Prefer a machine-readable reference? The interactive Swagger UI lives at api.okias.io/v1/docs and the OpenAPI spec at api.okias.io/v1/openapi.json.

Verify a user in 5 minutes

Three moving parts: create a verification from your server, let the user complete capture (hosted or your own UI), and receive the decision on a webhook. Here is the shortest path in the sandbox — no credits are spent with an ok_test_ key.

quickstart.sh
# 1 · Create a verification (from your server)
curl https://api.okias.io/v1/verifications \
  -H "Authorization: Bearer ok_test_..." \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{ "level": ["FULL_KYC"], "country": "pk", "end_user_ref": "user_8842" }'

# 2 · Send your user to the returned hosted_url, or upload assets yourself.
# 3 · Receive a signed webhook the moment the decision resolves.

That is the whole loop. Read Quickstart for the full walkthrough including reading the result, then Verifications for the complete request/response schema.

How verification works

You create a verification resource for one end user. OKIAS collects a government document and a live selfie (via the hosted flow or your own capture), then runs the checks your key is scoped to — document authenticity, active liveness, face match and sanctions screening against the official OFAC, EU, UK and UN lists. A deterministic scoring engine turns the signals into a single decision: APPROVED, REVIEW, DECLINED or ERROR, with a risk score and reason codes. The decision is pushed to your webhook and readable via the API.

There are exactly three purchasable checks — FULL_KYC, ID_DOCUMENT and AML_SCREENING. KYB, proof of address, bank-statement, phone and email checks are not built; sending them returns 400 VALIDATION_ERROR. See levels & checks.

Explore the docs

Jump straight to what you need — every page links back to related topics.

Quickstart
Verify your first user in five minutes — key, request, result.
Authentication & API keys
Live vs test keys, the Authorization header, rotation and security.
Verifications
Create checks, read the decision, risk scores and reason codes.
Hosted flow & Embed SDK
Redirect to the hosted link, or embed the flow on your own domain.
Webhooks
Signed events, HMAC verification snippets, retries and replay protection.
Errors & rate limits
The error envelope, common codes, status meanings and retries.
SDKs
The browser embed SDK today; server libraries in preview.
Partner program
10% recurring commission, attribution, ledger and payouts.
Reseller guide
Managed client sub-accounts, your own markup, consolidated billing.
Go-live checklist
Sandbox, funding, production keys, webhooks and compliance.

Get help

Stuck on something the docs do not cover? Email support@okias.io for integration support, or sales@okias.io for enterprise, partner and reseller onboarding.

Quickstart
Sign up, get a key, verify your first user.
Authentication & API keys
How keys work and how to keep them safe.
Next Quickstart