Onboard

Until the Management API ships, Docbooks is how you create the Organisation and Workspace that booking needs. This is setup, not the daily job — the daily job is Book a document.

Create the Organisation, then POST workspaces under it. Workspaces are not nested in the org body. Scope: docbooks.onboarding (capture-side admin will be docmind.onboarding / Management API). Batch up to 100. uid is ^CHE\d{9}$. actor is required on writes.

POST/api/docbooks/v1/onboarding/organisations

namestringbodyrequired

Legal name.

uidstringbodyrequired

Swiss UID without punctuation (CHE123456789).

extRefstringbodyrequired

Your stable id.

actorobjectbodyrequired

extRef, email, name.

Then:

POST/api/docbooks/v1/onboarding/organisations/{organisationId}/workspaces

Wait for ONBOARDING_FINALISED, then GET /api/docbooks/v1/onboarding/ plus the job id.

Offboard

Same scope. Organisation offboarding cascades workspaces. Workspace offboarding does not.

POST/api/docbooks/v1/offboarding/organisations

Body: actor, organisationIds (1–100), optional reason.

POST/api/docbooks/v1/offboarding/workspaces

Body: actor, workspaceIds (Docbooks ids), optional reason.

Then GET the offboarding job after OFFBOARDING_FINALISED. Per-item status is on that GET.

Tip

Full bodies: Docbooks OpenAPI.

Request
Onboard org
Offboard org
curl -X POST 'https://stage.docpier.io/api/docbooks/v1/onboarding/organisations' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{
    "name": "Acme AG",
    "uid": "CHE123456789",
    "extRef": "org-acme",
    "actor": {
      "extRef": "partner-user-01HXYZ",
      "email": "admin@partner.example",
      "name": "Operations"
    }
  }'
curl -X POST 'https://stage.docpier.io/api/docbooks/v1/offboarding/organisations' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{
    "organisationIds": ["01HXYZORG000000000000001"],
    "reason": "Client left the mandate",
    "actor": {
      "extRef": "partner-user-01HXYZ",
      "email": "admin@partner.example",
      "name": "Operations"
    }
  }'

Response

{
    "onboardingId": "01HXYZONBOARDING00000001",
    "status": "IN_PROGRESS",
    "createdAt": "2025-01-15T10:30:00.000Z"
}

Offboard 202 uses offboardingId instead of onboardingId.

Offboard​

Offboard