مرجع API

مولّد من التطبيق العامل.

https://api.warka-iq.com · OpenAPI 1.0.0 · openapi.json

get/healthz

Liveness

200 · object

post/v1/capture-sessions

Start a capture session

Creates a fresh, single-use session bound to one identity. Call this from your trusted backend, then pass `capture_token` and `upload_url` to the mobile app. Your API key must never reach the device. Each live session is one attempt, whatever its outcome, and so is each sandbox session on the free plan.

Idempotency-Key header · string | null
authorization header · string | null

application/json

client ClientContext | null
external_subject_id string | null
identity_id string | null

201 · SessionOut

capture_token stringrequired
Short-lived, single-session. Safe to hand to the mobile app.
expires_at required
id stringrequired
identity_id stringrequired
nonce stringrequired
object string
policy objectrequired
status stringrequired
upload_url stringrequired

post/v1/capture-sessions/{session_id}/frames

Upload a frame with a capture token

Called by the mobile app with `Authorization: Capture <capture_token>`. Upload success only means the file was stored. It proves nothing about the camera and records no attendance.

session_id path · stringrequired
authorization header · string | null

multipart/form-data

frame stringrequired
One JPEG or PNG frame

201 · FrameOut

frames_allowed integerrequired
frames_received integerrequired
frames_required integerrequired
object string
session_id stringrequired

get/v1/identities

List identities

limit query · integer
cursor query · string | null
status query · string | null
external_subject_id query · string | null
authorization header · string | null

200 · IdentityList

items IdentityOut[]required
next_cursor string | nullrequired

post/v1/identities

Enroll or re-enroll an identity

Send 3 to 5 good, recent face images of one person. Warka rejects inconsistent identities, stores an encrypted template and does not keep the images unless research processing applies. Set `re_enroll=true` to replace the template of an existing `external_subject_id`.

Idempotency-Key header · string | null
authorization header · string | null

multipart/form-data

display_label string | null
external_subject_id stringrequired
images string[]required
3 to 5 JPEG or PNG images
re_enroll boolean
research_use_allowed boolean | null

201 · IdentityOut

created_at required
display_label string | nullrequired
enrollment objectrequired
environment stringrequired
external_subject_id string | nullrequired
id stringrequired
last_verified_at required
object string
research_use_allowed boolean | nullrequired
status stringrequired
template_version integerrequired
updated_at required

delete/v1/identities/{identity_id}

Delete an identity

identity_id path · stringrequired
authorization header · string | null

200 · object

get/v1/identities/{identity_id}

Get an identity

identity_id path · stringrequired
authorization header · string | null

200 · IdentityOut

created_at required
display_label string | nullrequired
enrollment objectrequired
environment stringrequired
external_subject_id string | nullrequired
id stringrequired
last_verified_at required
object string
research_use_allowed boolean | nullrequired
status stringrequired
template_version integerrequired
updated_at required

patch/v1/identities/{identity_id}

Suspend, reactivate or update an identity

identity_id path · stringrequired
authorization header · string | null

application/json

display_label string | null
research_use_allowed boolean | null
status string | null

200 · IdentityOut

created_at required
display_label string | nullrequired
enrollment objectrequired
environment stringrequired
external_subject_id string | nullrequired
id stringrequired
last_verified_at required
object string
research_use_allowed boolean | nullrequired
status stringrequired
template_version integerrequired
updated_at required

post/v1/identities/{identity_id}/verify

Verify a capture session against an identity

Runs quality, PAD and 1:1 matching on the session's frames and returns a technical decision. Frames can be uploaded earlier with the capture token, or sent here by your backend as `frames`. Bad captures are normal outcomes and return HTTP 200 with a decision such as `retry_quality`. Warka returns a technical decision only: your application decides what happens to attendance and handles appeals.

identity_id path · stringrequired
Idempotency-Key header · string | null
authorization header · string | null

multipart/form-data

capture_session_id stringrequired
frames string[] | null
Optional frames from a trusted backend

200 · VerificationOut

capture objectrequired
capture_session_id string | nullrequired
created_at required
decision stringrequired
One of: approved, rejected_identity, rejected_spoof, retry_quality, manual_review, expired_session, not_enrolled, invalid_capture, system_unavailable
environment stringrequired
guidance string | nullrequired
id stringrequired
identity IdentitySignalrequired
identity_id string | nullrequired
model_versions objectrequired
object string
pad PadSignalrequired
policy stringrequired
quality objectrequired
reason stringrequired
request_id string | nullrequired
restricted_mode booleanrequired
true while PAD is unvalidated. Under this policy `approved` is never returned.
retry_allowed booleanrequired
timings_ms objectrequired

get/v1/models

Supported model versions

200 · ModelsOut

decisions string[]required
engine_ready booleanrequired
limitations string[]required
models object[]required
object string
policy stringrequired
release stringrequired
restricted_mode booleanrequired

get/v1/usage

Usage and quota for this key's organization

authorization header · string | null

200 · object

get/v1/verifications

List verifications

limit query · integer
cursor query · string | null
identity_id query · string | null
authorization header · string | null

200 · VerificationList

items VerificationOut[]required
next_cursor string | nullrequired

get/v1/verifications/{verification_id}

Get a verification

verification_id path · stringrequired
authorization header · string | null

200 · VerificationOut

capture objectrequired
capture_session_id string | nullrequired
created_at required
decision stringrequired
One of: approved, rejected_identity, rejected_spoof, retry_quality, manual_review, expired_session, not_enrolled, invalid_capture, system_unavailable
environment stringrequired
guidance string | nullrequired
id stringrequired
identity IdentitySignalrequired
identity_id string | nullrequired
model_versions objectrequired
object string
pad PadSignalrequired
policy stringrequired
quality objectrequired
reason stringrequired
request_id string | nullrequired
restricted_mode booleanrequired
true while PAD is unvalidated. Under this policy `approved` is never returned.
retry_allowed booleanrequired
timings_ms objectrequired