Skip to content

Dashboard API ​

The management surface used by the dashboard UI. Auth: Authorization: Bearer <jwt>.

Organization-scoped routes run through resolveOrganization (the caller must be an active member) and a can('…') permission guard. The required permission is listed per route below.

Auth ​

Base: /api/v1/auth (no auth unless noted).

MethodPathAuthDescription
POST/v1/auth/registernoneRegister a user; returns a bearer token.
POST/v1/auth/loginnoneVerify credentials; issue a session token.
GET/v1/auth/meJWTThe authenticated user.
DELETE/v1/auth/logoutJWTRevoke the current token.
POST/v1/auth/invitations/acceptJWTAccept an organization invitation by token.
POST/v1/auth/forgotnoneEmail a password-reset code.
PUT/v1/auth/forgot/:tokennoneConsume a reset token; set a new password.

Account ​

The signed-in user's own notifications, devices, invitations and realtime access. Base: /api/v1 · Auth: JWT.

MethodPathDescription
GET/v1/account/notificationsNotifications, newest first (paginated; ?unread=1), with unread_count.
PATCH/v1/account/notifications/:id/readMark one notification read.
PATCH/v1/account/notifications/readMark all unread notifications read (or only ids).
DELETE/v1/account/notifications/:idDelete a notification.
GET/v1/account/notification-preferencesDelivery preferences (push).
PATCH/v1/account/notification-preferencesUpdate the preferences.
POST/v1/account/push-tokensRegister this device's push token (token, platform, device_name).
DELETE/v1/account/push-tokensUnregister this device.
GET/v1/account/invitationsPending invitations for the user's email (verified email required; paginated).
GET/v1/account/invitations/countHow many pending invitations the user has (zero until the email is verified).
PATCH/v1/account/invitations/:id/acceptAccept a pending invitation without the link token (verified email required).
POST/v1/realtime/authAuthorize a private realtime channel (organization, project, session or own user).
GET/v1/realtime/configThe realtime transport and its public connection settings.

Users are notified when a session needs their review, a review is assigned to them, someone else decides a session assigned to them, a webhook endpoint they maintain stops delivering, and when they are invited to an organization.

Organizations ​

Base: /api/v1/dashboard/organizations

MethodPathPermissionDescription
GET/organizationsnoneList the caller's organizations (paginated).
POST/organizationsnoneCreate an organization; seeds roles; caller = owner.
GET/organizations/:organizationIdorganizations.viewShow the organization.
PATCH/organizations/:organizationIdorganizations.updateUpdate name / logo / settings.
DELETE/organizations/:organizationIdorganizations.deletePermanently delete it with everything in it. Body name must match exactly (422 otherwise).
GET/organizations/:organizationId/verificationorganizations.viewBusiness verification status, whether it can go live, and the latest submission.
POST/organizations/:organizationId/verificationorganizations.updateSubmit business verification (multipart; see Business verification). 201; 409 while one is under review or once verified.
GET/organizations/:organizationId/verification/documents/:kindorganizations.viewStream an uploaded document (incorporation or data_protection).

Deleting an organization also deletes every project, session, captured file, member, role and audit log in it. The deletion is recorded in the platform audit log, and runs on the maintenance queue.

Members & invitations ​

Base: /api/v1/dashboard/organizations/:organizationId

MethodPathPermissionDescription
GET/menoneCaller's role / direct / effective perms.
GET/membersmembers.viewList members (paginated).
GET/members/:memberIdmembers.viewMember detail.
PATCH/members/:memberIdmembers.updateChange a member's role.
POST/invitationsmembers.inviteInvite an email with a role.
GET/members/:memberId/permissionsmembers.viewMember's role / direct / effective perms.
POST/members/:memberId/permissionsmembers.updateGrant a direct organization permission.
DELETE/members/:memberId/permissions/:permissionmembers.updateRevoke a direct permission.

Projects & project members ​

Base: /api/v1/dashboard/organizations/:organizationId/projects

MethodPathPermissionDescription
GET/projectsprojects.viewList projects (paginated).
POST/projectsprojects.createCreate a project.
GET/projects/:projectIdprojects.viewShow a project.
PATCH/projects/:projectIdprojects.updateUpdate name/status/settings/branding/thresholds.
DELETE/projects/:projectIdprojects.deletePermanently delete it with its sessions, media, keys and webhooks. Body name must match exactly.
GET/projects/:projectId/extended-accessprojects.viewPer-capability extended-access status.
POST/projects/:projectId/extended-access/requestprojects.updateRequest capabilities (capabilities[], pii).
GET/projects/:projectId/membersmembers.viewList project members.
POST/projects/:projectId/membersmembers.updateAdd an organization member to the project.
PATCH/projects/:projectId/members/:memberIdmembers.updateChange a project member's role.
DELETE/projects/:projectId/members/:memberIdmembers.removeRemove a project member.

A production project needs a verified business: until then, creating one returns 422 on environment, and new projects default to development. Branding starts with Arkyc's primary color.

thresholds takes any of documentQualityThreshold, ocrConfidenceThreshold, livenessThreshold, faceMatchThreshold, faceMatchRejectThreshold and addressThreshold, each a number from 0 to 1; null clears an override. faceMatchRejectThreshold may not exceed faceMatchThreshold (422). Unknown keys are ignored.

API keys ​

Base: /api/v1/dashboard/organizations/:organizationId/projects/:projectId/api-keys

MethodPathPermissionDescription
GET/api-keysapi_keys.viewList keys (secret never returned).
POST/api-keysapi_keys.createMint a key; plaintext secret returned once.
DELETE/api-keys/:keyIdapi_keys.revokeRevoke a key.

Webhooks ​

Base: /api/v1/dashboard/organizations/:organizationId/projects/:projectId/webhooks

MethodPathPermissionDescription
GET/webhookswebhooks.viewList endpoints (secret never returned).
POST/webhookswebhooks.createRegister an endpoint; secret returned once.
PATCH/webhooks/:webhookIdwebhooks.updateUpdate url / events / status.
DELETE/webhooks/:webhookIdwebhooks.deleteDelete an endpoint.
POST/webhooks/:webhookId/testwebhooks.testQueue a sample delivery.

See Webhooks for the payload and signature.

Sessions & reviews ​

Base: /api/v1/dashboard/organizations/:organizationId

MethodPathPermissionDescription
GET/sessionssessions.viewList sessions; filter by status, decision_reason, project_id.
GET/reviews/countreviews.viewHow many sessions await review (for the nav badge).
GET/sessions/:idsessions.viewSession detail, including its risk_signals.
POST/sessions/:id/approvereviews.approveApprove; optional reason.
POST/sessions/:id/rejectreviews.rejectReject; optional reason.
POST/sessions/:id/request-retryreviews.request_retryRequest a kind retry (document/selfie/full).
POST/sessions/:id/assignreviews.assignAssign to a reviewer (user_id).
POST/sessions/:id/suspiciousreviews.noteFlag as suspicious.
POST/sessions/:id/notesreviews.noteAttach a reviewer note.
PATCH/sessions/:id/risk-signals/:signalId/clearreviews.approveClear a risk signal as a false positive; reason required, audited. Returns 201.

Audit logs ​

MethodPathPermissionDescription
GET/audit-logsaudit_logs.viewList audit entries; filter by action, entity_type.

Roles & permissions ​

Base: /api/v1/dashboard/organizations/:organizationId

MethodPathPermissionDescription
GET/permissionssettings.viewThe permission catalogue, grouped.
GET/rolessettings.viewList roles (paginated).
POST/rolessettings.updateCreate a custom role with permissions.
GET/roles/:roleIdsettings.viewShow a role with its permission names.
PATCH/roles/:roleIdsettings.updateUpdate a role's name / description / perms.

Admin (platform) ​

Base: /api/v1/admin, Authorization: Bearer <jwt> plus a platform canAdmin('…') permission. This surface sits above organizations; an organization role never grants admin access (no resolveOrganization).

MethodPathPermissionDescription
GET/menoneCaller's admin standing (empty for non-admins).
GET/settingsadmin.settings.viewPlatform settings.
PATCH/settingsadmin.settings.updateUpdate platform settings.
GET/organizationsadmin.organizations.viewList organizations (paginated).
GET/organizations/:organizationIdadmin.organizations.viewOrganization detail: verification, counts, session outcomes, 30-day trend, top risk signals.
GET/organizations/:organizationId/projectsadmin.organizations.viewThe organization's projects (paginated).
GET/organizations/:organizationId/projects/:projectIdadmin.organizations.viewOne project in depth: configuration, counts, outcomes, access and recent sessions.
PATCH/organizations/:organizationId/verificationadmin.organizations.manageMark an organization verified or unverified directly (verified).
GET/usersadmin.users.viewList users (paginated).
GET/users/:userIdadmin.users.viewUser detail.
POST/users/:userId/adminadmin.users.manageGrant platform admin.
DELETE/users/:userId/adminadmin.users.manageRevoke platform admin (never the last admin).
POST/users/:userId/statusadmin.users.manageSet account standing: active/restricted/suspended.
POST/users/:userId/passwordadmin.users.manageReset a user's password.
GET/audit-logsadmin.audit.viewPlatform audit log.

Business verification ​

MethodPathPermissionDescription
GET/business-verificationsadmin.organizations.viewSubmissions, newest first; filter by status.
GET/business-verifications/countadmin.organizations.viewSubmissions awaiting review (for the nav badge).
GET/business-verifications/:idadmin.organizations.viewOne submission with its organization.
GET/business-verifications/:id/documents/:kindadmin.organizations.viewStream an uploaded document.
PATCH/business-verifications/:id/approveadmin.organizations.manageApprove (optional note); the organization can go live.
PATCH/business-verifications/:id/rejectadmin.organizations.manageReject with a required note saying what to fix.

The organization's managers are notified of the decision. PATCH /settings takes compliance.business_verification_required to switch the production gate off or on.

Extended access ​

Gate project capabilities per project. The registry currently defines ai (the AI OCR driver) and pii (reading the extracted identity/address data back). Each capability is a separate request/grant, so an admin can approve one and leave another pending. Project owners request capabilities (under Projects); admins list, review, grant, and revoke here.

MethodPathPermissionDescription
GET/extended-accessadmin.extended_access.viewList grants; filter by status/capability.
GET/extended-access/countadmin.extended_access.viewCount of pending requests (for the nav badge).
GET/extended-access/projects/:projectIdadmin.extended_access.viewA project's grants across every capability.
POST/extended-access/grantadmin.extended_access.manageGrant a capability (project_id, capability).
POST/extended-access/revokeadmin.extended_access.manageRevoke a capability (project_id, capability).

A PII request carries pii: { categories: ["identity","address"], timing: "before" | "after", justification }. Once granted, the extracted data is read only through the server SDK's sessions.retrieve() (secret key); it is never sent to the browser widget or included in webhooks. See Extracted PII.

Released under the MIT License.