Workflows and the builder
A workflow is the list of steps an applicant completes and the rules that decide the outcome.
Build workflows in the dashboard under Workflows. The builder shows the flow as a canvas: Start (the applicant opens the link) → your steps → Automatic checks → Decision. Select a step to configure it in the inspector; undo/redo with ⌘Z / ⇧⌘Z.
Steps
Each step uses a capability. The workflow's country pack turns capabilities into concrete screens and checks when you publish, so the same workflow shape works in other countries.
| Capability | India, for example |
|---|---|
consent | DPDP consent notice (always first; the applicant must accept every purpose). |
phone / email | One-time code (phone via WhatsApp and/or SMS). |
tax_id | PAN verified with the tax department. |
national_eid | Aadhaar via DigiLocker, Offline XML or Secure QR (the number is never stored). |
id_document | Photo of a passport, PAN card, voter ID or licence (OCR, quality and tamper checks). |
liveness / face_match | Selfie with a movement challenge, matched to the Aadhaar or document photo. |
bank_account | UPI ID or account + IFSC, with holder name. |
address | Address entry or confirmation. |
documents | Collect documents, optionally extracting data. |
sanctions / pep | Watchlist screening on the verified name, after submission (system steps). |
duplicate_check | Looks for earlier sessions in the project that look like the same person or business — see Duplicate detection. |
business_registry, tax_registration, business_documents, related_persons | KYB: company (MCA), GSTIN, company documents, one KYC session per director/UBO. |
Step options include optional (the applicant may skip it), methods (e.g. which Aadhaar methods to offer),
channel (whatsapp, sms), face_match_against and, for related_persons, the KYC workflow each person
completes.
Camera steps guide the applicant live. Document photos are taken automatically once the framed image is sharp, steady and free of glare. The selfie starts its challenge once the applicant's face is centred in the oval. Face guidance runs on the applicant's device with a model served by OKYC: no frames leave the device until the challenge starts, and the server alone decides liveness. On devices that can't run it, the applicant taps I'm ready instead.
Settings
| Setting | Default | |
|---|---|---|
| Attempts per step | 3 | Before the step fails. |
| Desktop → phone handoff | on | Offer a QR to continue on a phone before camera steps. |
| Session lifetime | 168 hours | Default expires_at for new sessions. |
| Face match threshold | 0.8 | Minimum face similarity. |
| Minimum ML confidence | 0.7 | Minimum confidence accepted from ML checks. |
| Languages | — | The languages the flow offers (en, hi); a session's locale must be one of them. |
Branding
Set how the hosted flow looks under Branding in the dashboard. The project default applies to every workflow in the project (owners and admins change it); a workflow override changes only the fields you set for that workflow (developers and admins), and everything else is inherited. Choose A workflow under Applies to to edit one: each section shows Inherited or Overridden, and Reset to project default clears the override. A live phone preview shows the welcome, selfie and result screens in light and dark, in English and Hindi.
Branding is not versioned: saving applies immediately to new and running sessions of the workflow.
| Field | |
|---|---|
| Square logo, wide logo | https:// URLs. The wide logo is used in the header. |
| Primary colour | Buttons and accents. The dashboard shows whether it meets WCAG AA in light and dark. |
| Background colour | Page background in light mode; dark mode keeps the dark palette. |
| Font | Plus Jakarta Sans, Inter, Roboto, Poppins or Noto Sans (Hindi falls back to Noto Sans Devanagari). |
| Corner radius | 0–24 px. |
| Colour scheme | Auto (follow the device), Light or Dark. |
| Completion screen | Show decision, or Always "Submitted": a neutral "details received" screen whatever the outcome (useful when you decide later or review manually). |
| Text | Per language: welcome title and message, completion title and message (up to 300 characters). You can use the placeholders {appName}, {stepIndex} and {stepTotal}. |
| Show "Secured by OKYC" | On by default. Turn it off for a fully white-labelled flow: the footer and the OKYC mark and its animations (processing, step done, result screens) are hidden, and neutral visuals are shown instead. |
Versions
Saving edits a draft. Publish validates the workflow and freezes it into an immutable version (including field definitions). Running sessions keep the version they started with; new sessions use the latest. Version history lets you restore an old version into the draft. You can start a test session from the draft before publishing.
Via the API, workflows are read-only: GET /v1/workflows and GET /v1/workflows/:id.
Organizations and projects
People belong to an organization; keys, workflows, sessions and settings belong to a project.
Decision rules
JSONLogic rules over check results decide approved, declined or review — or fall through to the default outcome.
© 2026 Aiistic Technologies Private Limited. OKYC is a product of Aiistic Technologies Private Limited. Privacy notice