Zanyara developer documentation
One API to verify who your customers are: document verification, face match, liveness and AML screening, delivered as a single decision. Drop in a capture SDK for web, iOS or Android, or call the REST API directly and receive the outcome by webhook.
What the platform does
Document verification
Passports, ID cards, driving licences and residence permits — MRZ parsing and NFC chip reading where supported.
Face match & liveness
Match the selfie to the document photo, with active and passive liveness / presentation-attack detection.
AML screening
Sanctions, PEP and adverse-media screening, with optional ongoing monitoring for perpetual KYC.
Human review
Borderline checks route to reviewers in the operator console; the decision arrives by webhook when they resolve it.
The verification flow
- Create a checkCall the API (or trigger from the console) to open a verification for an applicant and get back a check id and a capture session.
- Collect the document & selfieHand the session to a Web / iOS / Android SDK for guided capture — auto-capture, quality gates, NFC and liveness — or submit images to the API yourself.
- We run the checksDocument authenticity, face match, liveness and AML screening are evaluated into one result; anything borderline is routed to human review.
- Receive the decision by webhookA signed webhook fires the moment the decision lands. Verify it and act on it — see the webhook security guide.
Authentication
Server-to-server API calls authenticate with a secret API key sent as a bearer token; keep it on your backend, never in client code. Capture SDKs use short-lived, per-session tokens minted by your server, so long-lived secrets never reach the browser or device. Each environment — sandbox and production — has its own keys.
This page is a conceptual overview; exact endpoint paths, field names and error codes are in the full API reference we’ll share with your sandbox key.
SDKs
- Web SDK — a drop-in JavaScript capture flow with hosted, guided document and selfie steps.
- iOS SDK — native capture including NFC chip reading (CoreNFC) and on-device liveness.
- Android SDK — native capture including NFC chip reading and liveness.
- REST API + webhooks — drive the flow yourself and receive decisions asynchronously.
Frequently asked questions
- How do I start with the Zanyara API?
- Ask us for a free sandbox key, then create your first verification check against the sandbox environment with test documents and mock decisions — no live data and no charge. When you’re ready, the same integration points at production by swapping the key.
- Do I have to use the SDKs, or can I call the REST API directly?
- Either. The Web, iOS and Android SDKs give you guided capture (auto-capture, quality checks, NFC and liveness) out of the box; the REST API lets you drive the flow yourself and receive decisions by webhook. Most teams use an SDK for capture and the API for orchestration.
- How are results delivered?
- In two places: synchronously in the API response and console, and asynchronously bywebhook the moment a decision lands (including checks routed to human review). See the webhook security & idempotency guide.
- How long does an integration take?
- A typical integration — trigger a check, collect a document and selfie, receive the decision by webhook — ships in days, not months. Guided capture and the webhook contract are the two pieces most teams wire up first.