Skip to Content

Onboarding

Endpoints for managing tenant onboarding lifecycle and certification.

Onboarding State Machine

created → network_pending → identity_pending → byok_pending → validation_pending → certification_pending → go_live_ready → live ↘ blocked
StateDescription
createdTenant record created
network_pendingWaiting for private network setup
identity_pendingWaiting for OIDC identity configuration
byok_pendingWaiting for BYOK credential upload
validation_pendingCredential uploaded, validation pending
certification_pendingValidation passed, certification pending
go_live_readyAll checks passed, ready for production
liveActive in production
blockedError state requiring remediation

GET /v1/admin/onboarding/status

Returns comprehensive onboarding progress for the current tenant.

PropertyValue
Authtenant_admin or tenant_viewer role

Response includes:

  • Current state and checklist (pending/completed/blocked steps)
  • Blockers with retryable flags
  • BYOK summary (configured, validation_status, fingerprint, timestamps)
  • Certification summary (status, last_run_operation_id, passed)

POST /v1/admin/integrations/{integration_id}/certifications

Run integration-scoped certification workflow. Always returns 202 (async).

PropertyValue
Authtenant_admin role
IdempotentYes
AsyncAlways

Modes

ModeTests
quickProofread test + operation poll verification
fullProofread test + essay-critique test + operation poll verification

Preconditions (409 if unmet)

  • BYOK credential must be configured and validated
  • Integration must be active
  • Integration auth config must be active
  • Integration connectivity must be verified
  • No other certification currently running

Route Retirement

POST /v1/admin/onboarding/certify is retired and returns 410.

See the Certification Guide for a complete walkthrough.

Last updated on