Zquence V2 exposes 14 tenant-facing external API groups for enterprise integrations. These groups are intended for tenant systems such as CRMs, BI dashboards, SharePoint workflows, compliance queues, and internal portals. For the detailed endpoint list, use the API reference sidebar groups. Start with KYC API, Document review API, and Webhook events.
Status means API-key readiness for tenant external integrations, not whether internal admin console routes exist. A backend route must have an API-key scope before tenants should build against it with API keys.
#API groupStatusPrimary use
1Authentication, API keys, scopes, and usagePartialDiscover scopes/catalog metadata; key lifecycle management remains console/JWT-only until explicit management scopes ship.
2Tenant profile, branding, legal content, and environment contextPartialMirror tenant portal configuration.
3Environments and sandbox controlsPartialSeparate sandbox/live integrations and test deterministic flows.
4Tenant users and team provisioningImplementedSync users from external systems.
5Roles and permissions catalogRecommendedMap Zquence access models into enterprise IAM dashboards.
6Accounts lifecycle and invite managementImplementedBuild external account dashboards and invite workflows.
7KYC lifecycle, status, history, reuse, and exportsImplementedSync identity verification state into compliance tools.
8Source of fundsImplementedRead submitted source-of-funds status.
9Document reviewImplementedTrack document requirements and review outcomes.
10Signature documents and signed contractsPartialIntegrate contract requests and signed PDF retrieval.
11Sanctions screening, logs, review, and usagePartialSync risk outcomes and screening logs.
12Billing, entitlements, ledger, invoices, and requestsPartialBuild billing and credit dashboards.
13Audit logs, request logs, and integration observabilityPartialFeed SIEM, operational dashboards, and support tools.
14Webhook endpoint management, event catalog, delivery logs, and retriesPartialReceive signed events today; management APIs need explicit webhook scopes before API-key rollout.

​
Current scope model

API key creation supports these scopes today:
ScopeCategoryAccess
tenants.readTenantsRead
environments.readEnvironmentsRead
accounts.readAccountsRead
kyc.readKYCRead
document-reviews.readDocument reviewRead
document-reviews.writeDocument reviewWrite
source-of-funds.readSource of fundsRead
files.downloadFilesDownload
tenant-users.readUsersRead
tenant-users.writeUsersWrite
invites.writeInvitesWrite
sanctions.screenSanctionsWrite
sanctions.readSanctionsRead
sanctions.reviewSanctionsWrite
sanctions.exportSanctionsDownload
webhooks.readWebhooksRead
webhooks.writeWebhooksWrite

​
API-key access rule

Every API-key route is opt-in. Implemented routes require one of the scopes above. Default dashboard routes reject API-key headers and require a user session. Every live and sandbox API key receives the complete scope list when it is created. Existing active keys are synchronized additively when documented scopes are introduced. There is no public API endpoint to update scopes on an existing key. Keep these APIs internal to the Zquence admin console or super-admin operations:
  • Provider credentials and lifecycle mutation.
  • Provider cost and pricing catalog mutation.
  • Tenant deletion and recovery mutation.
  • Cross-tenant reconciliation recovery actions.
  • Platform legal content assignment and platform billing setup.

​
Integration checklist

  1. Create separate sandbox and live keys.
  2. Confirm the key lists the complete current scope catalog.
  3. Include x-api-key and x-api-secret; use environment headers only where endpoint docs require them.
  4. Use pagination for list endpoints.
  5. Treat 429 responses as rate-limit signals and back off.
  6. Verify webhook signatures and deduplicate on event.id.
  7. Store PII, exports, and webhook payloads according to tenant data-residency policy.