Skip to main content
Documentation

Integrate OKIAS identity verification

OKIAS is a developer-first AI KYC/IDV API: document checks, liveness detection, 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. A Swagger UI is published at api.okias.io/v1/docs and the OpenAPI spec at api.okias.io/v1/openapi.json, but it is incomplete (no request/response schemas yet) — these docs are the reference.

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. For a no-charge rehearsal, create a hosted test link in Developer → Sandbox before using this live API example.

quickstart.sh
# 1 · Create a verification (from your server)
curl https://api.okias.io/v1/verifications \
  -H "Authorization: Bearer ok_live_..." \
  -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, liveness detection, 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.

The KYC verification levels are FULL_KYC, ID_DOCUMENT and AML_SCREENING. Proof of address and bank-statement checks are not built. Phone and email verification are separate capabilities with their own WhatsApp & Email OTP APIs; KYB availability remains catalogue-controlled.

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-only API keys, hosted Sandbox testing, rotation and security.
Verifications
Create checks, read the decision, risk scores and reason codes.
Business verification (KYB)
Dynamic requirements, versioned scope quotes, case lifecycle, upgrades, webhooks and sandbox.
Integration Services
Scoped specialist integrations, quotations, verified payments and secure project tracking.
Reusable applicant identity
Consent, saved records, fresh liveness and tenant-scoped duplicate control.
Billing, credits & usage
Balances, holds, transactions, account quotes and reseller usage.
WhatsApp, SMS & Email OTP
OTP-only keys, independent phone and email verification, plus delivery status.
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.
Shareable KYC links
One link, many people — each opener gets an independent verification.
Bring your own AI key
Run AI verifications on your own Google Gemini key.
White-label & merchant decisions
Subscription, your own branding and deciding verifications yourself.
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% commission on approved LIVE verifications of the accounts you refer, attribution, ledger and payouts.
Reseller guide
Managed client accounts billed to your prepaid balance; you invoice your clients yourself.
Go-live checklist
Sandbox, funding, production keys, webhooks and compliance.

Get help

Stuck on something the docs do not cover? Email [email protected] for integration support, or [email protected] for enterprise, partner and reseller onboarding.