UpPass API

See it work

What you will build

The diagram reads top to bottom. Each box maps to one of these steps:

1. Create a new UpPass form. Your backend calls Create application, optionally with answers you already hold — the predefined answers payload.

2. Generate a new form. UpPass returns a form_url and a slug. Store the slug against your own user or session record. That table is the UpPass session mapping in the diagram — it is yours, in your database, and it is how you will match the result back to the right person.

3. Redirect customer to UpPass form. Hand the applicant the form_url — a redirect, a shared link, a QR code, or an in-app WebView.

4. Performing UpPass flow. The applicant scans their ID, completes a liveness check and submits. UpPass shows a thank-you page, then sends them to the callback URL you set in Form → Builder → Settings (the last page of the builder).

5. UpPass webhook result. UpPass POSTs the full result to your webhook. Look up your record by application.slug, store the result, and show the outcome to the customer.

Diagram box	Where it lives	Step
Create a new UpPass form	Your backend	1
Generate a new form	UpPass	1
UpPass session mapping	Your database — slug ↔ your user	2
Redirect customer to UpPass form	Your UI	3
Start eKYC flow → Thank you page	UpPass UI, on the applicant’s device	4
Redirect to callback URL	Your UI — the URL set in Form → Builder → Settings	4
UpPass webhook result → Save UpPass result	UpPass → your backend	5

Read the result from extra

other_status.ekyc is a summary: the document scan and the liveness check, combined. The detail behind it — face-comparison score, liveness attempts, document fields, screening results — lives in extra.

Reading the result walks through it field by field.

Start here

Quick StartToken, one create call, one webhook — the whole integration on one page.

Values you needEvery placeholder in these docs, and where to find the real value.

Create an applicationOne call creates a verification and returns the link you hand the applicant.

Set up your workspaceThe Portal steps to complete once, before you write integration code.

Delivery patternsHosted link, QR code, or embedded WebView. Pick one.

Reading the resultWhich fields carry the verdict, and why to read them from extra.

Receiving webhooksReceiver contract, idempotency, and the 15-minute image window.

The webhook payloadOne complete example, then every object and field specified. Downloadable JSON.

Definitions

Term	Meaning
workspace	Container for all flows on an account. One per account; others by invitation.
form / flow	A verification form built in the Portal.
form_slug	Programmatic name of a flow. Found in Flows → your flow → Settings.
lang	UI locale for the generated form, as a URL path prefix.
slug	Identifier of one applicant’s application. One per applicant.
step / section	Position within the flow.
answers	Map of question_key → value: OCR output, applicant input, and any values you pre-filled.
extra	Verification artefacts — document scans, liveness frames, face comparison, AML screening.
applied_form	Internal name for an application.