Workspace

Base URL: $BUSINESS_API

The object

statusstring · required
verification_requirementsarray of string · required
catalogarray of VerificationRequirementDefinition · required
Show child attributes
keystring · required
label_keystring · required
labelsobject · optional

Localized labels for configured custom requirements.

applies_toarray of string · required
checked_bystring · required
requirementsobject · required
Show child attributes
currently_duearray of string · optional
eventually_duearray of string · optional
past_duearray of string · optional
pending_verificationarray of string · optional
errorsarray of object · optional
Show child attributes
requirementstring · optional
codestring · optional

one of information_requested, document_rejected

reasonstring · optional
capabilitiesobject · required
Show child attributes
configurestring · optional

one of inactive, pending, active, restricted

customersstring · optional

one of inactive, pending, active, restricted

metersstring · optional

one of inactive, pending, active, restricted

draft_billingstring · optional

one of inactive, pending, active, restricted

invoicesstring · optional

one of inactive, pending, active, restricted

paymentsstring · optional

one of inactive, pending, active, restricted

messagesstring · optional

one of inactive, pending, active, restricted

public_profilestring · optional

one of inactive, pending, active, restricted

custom_domainstring · optional

one of inactive, pending, active, restricted

live_apistring · optional

one of inactive, pending, active, restricted

sandboxstring · optional

one of inactive, pending, active, restricted

billingstring · optional

one of inactive, pending, active, restricted

field_operationsstring · optional

one of inactive, pending, active, restricted

statesobject · optional
reasonsobject · optional

Actionable reason for each non-active capability.

The object
{
  "status": "active",
  "verification_requirements": [
    "verification requirement"
  ],
  "catalog": [
    {
      "key": "key",
      "label_key": "label key",
      "labels": {
        "key": "value"
      },
      "applies_to": [
        "2026-11-19"
      ],
      "checked_by": "checked by"
    }
  ],
  "requirements": {
    "currently_due": [
      "currently due"
    ],
    "eventually_due": [
      "eventually due"
    ],
    "past_due": [
      "past due"
    ],
    "pending_verification": [
      "pending verification"
    ],
    "errors": [
      {
        "requirement": "requirement",
        "code": "information_requested",
        "reason": "Leitura confirmada no local."
      }
    ]
  },
  "capabilities": {
    "configure": "inactive",
    "customers": "inactive",
    "meters": "inactive",
    "draft_billing": "inactive",
    "invoices": "inactive",
    "payments": "inactive",
    "messages": "inactive",
    "public_profile": "inactive",
    "custom_domain": "inactive",
    "live_api": "inactive",
    "sandbox": "inactive",
    "billing": "inactive",
    "field_operations": "inactive",
    "states": {
      "key": "inactive"
    },
    "reasons": {
      "key": {
        "code": "requirements_due",
        "requirements": [
          "requirement"
        ]
      }
    }
  }
}

Get workspace verification requirements

Logs

GET /workspace/verification/requirements

Get the active workspace verification requirements and capability states

Returns the verification picture of the caller's workspace: the onboarding status, the verification requirement codes that apply to it under its policy, the catalogue definitions of those requirements, the requirement states (currently due, eventually due, past due, pending verification, errors) and the capabilities enabled so far with the reasons blocking the rest. An onboarding application is created on first read if the workspace has none. Requires business onboarding read access.

Returns

200 Requirement progress and capability states for the active workspace

Show attributes
statusstring · required
verification_requirementsarray of string · required
catalogarray of VerificationRequirementDefinition · required
Show child attributes
keystring · required
label_keystring · required
labelsobject · optional

Localized labels for configured custom requirements.

applies_toarray of string · required
checked_bystring · required
requirementsobject · required
Show child attributes
currently_duearray of string · optional
eventually_duearray of string · optional
past_duearray of string · optional
pending_verificationarray of string · optional
errorsarray of object · optional
Show child attributes
requirementstring · optional
codestring · optional

one of information_requested, document_rejected

reasonstring · optional
capabilitiesobject · required
Show child attributes
configurestring · optional

one of inactive, pending, active, restricted

customersstring · optional

one of inactive, pending, active, restricted

metersstring · optional

one of inactive, pending, active, restricted

draft_billingstring · optional

one of inactive, pending, active, restricted

invoicesstring · optional

one of inactive, pending, active, restricted

paymentsstring · optional

one of inactive, pending, active, restricted

messagesstring · optional

one of inactive, pending, active, restricted

public_profilestring · optional

one of inactive, pending, active, restricted

custom_domainstring · optional

one of inactive, pending, active, restricted

live_apistring · optional

one of inactive, pending, active, restricted

sandboxstring · optional

one of inactive, pending, active, restricted

billingstring · optional

one of inactive, pending, active, restricted

field_operationsstring · optional

one of inactive, pending, active, restricted

statesobject · optional
reasonsobject · optional

Actionable reason for each non-active capability.

Errors 401

Permissions business:onboarding:read · Roles: admin, owner

curl -X GET "$BUSINESS_API/workspace/verification/requirements" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "status": "active",
  "verification_requirements": [
    "verification requirement"
  ],
  "catalog": [
    {
      "key": "key",
      "label_key": "label key",
      "labels": {
        "key": "value"
      },
      "applies_to": [
        "2026-11-19"
      ],
      "checked_by": "checked by"
    }
  ],
  "requirements": {
    "currently_due": [
      "currently due"
    ],
    "eventually_due": [
      "eventually due"
    ],
    "past_due": [
      "past due"
    ],
    "pending_verification": [
      "pending verification"
    ],
    "errors": [
      {
        "requirement": "requirement",
        "code": "information_requested",
        "reason": "Leitura confirmada no local."
      }
    ]
  },
  "capabilities": {
    "configure": "inactive",
    "customers": "inactive",
    "meters": "inactive",
    "draft_billing": "inactive",
    "invoices": "inactive",
    "payments": "inactive",
    "messages": "inactive",
    "public_profile": "inactive",
    "custom_domain": "inactive",
    "live_api": "inactive",
    "sandbox": "inactive",
    "billing": "inactive",
    "field_operations": "inactive",
    "states": {
      "key": "inactive"
    },
    "reasons": {
      "key": {
        "code": "requirements_due",
        "requirements": [
          "requirement"
        ]
      }
    }
  }
}

Request workspace close

Logs

POST /workspace/close

Close the active workspace and begin its configured recovery period

Owner only. Name another active owner as successor. Writes stop immediately. The response includes the existing compliance export endpoint and the configured deletion due date; this request does not delete tenant data.

Body application/json

successor_member_idstring · required

Active tenant owner membership that will retain ownership after closure

Returns

202 Workspace closed for use; data remains available for export during the grace period

Show attributes
tenantobject · required
Show child attributes
idstring · required
owner_organization_idstring · required
slugstring · required
namestring · required
statusstring · required

one of provisioning, active, suspended, closed

kindstring · required

one of live, sandbox

workspace_statestring · required

one of sandbox_only, unverified, verifying, live, restricted, suspended, closed, sandbox

parent_tenant_idstring · optional
copied_from_tenant_idstring · optional
template_keystring · optional
closed_atstring · optional · nullable
deletion_due_atstring · optional · nullable
country_codestring · optional
localestring · required
currencystring · required
timezonestring · required
export_pathstring · required
deletion_due_atstring (date-time) · required

Errors 401 · 403 · 409

Permissions business:organization:read, business:team:read · Roles: admin, owner

curl -X POST "$BUSINESS_API/workspace/close" \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "successor_member_id": "suc_2jVWyrdmOLjMKhhC2nXY4nnW4nZ"
}'
Response 202
{
  "tenant": {
    "id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
    "owner_organization_id": "own_2Hj8Qbz4glBOQR5aWPneq1JWux7",
    "slug": "slug",
    "name": "Ana Matsinhe",
    "status": "provisioning",
    "kind": "live",
    "workspace_state": "sandbox_only",
    "parent_tenant_id": "par_21NQMtrA6ldIklFucB3eoRxCqDB",
    "copied_from_tenant_id": "cop_2sEl3AsnbMmfvSknXeeX3YMH7WK",
    "template_key": "template key",
    "closed_at": "2026-11-19T09:30:00Z",
    "deletion_due_at": "2026-11-19T09:30:00Z",
    "country_code": "MZ",
    "locale": "pt",
    "currency": "MZN",
    "timezone": "Africa/Maputo"
  },
  "export_path": "$BUSINESS_API/export/compliance",
  "deletion_due_at": "2026-11-19T09:30:00Z"
}

Reverse workspace close

Logs

POST /workspace/close/reverse

Reopen the active workspace during its configured recovery period

Owner only. Restores the lifecycle and verification state that existed before closure. The operation is refused after the deletion due date.

Returns

200 Workspace reopened

Show attributes
tenantobject · required
Show child attributes
idstring · required
owner_organization_idstring · required
slugstring · required
namestring · required
statusstring · required

one of provisioning, active, suspended, closed

kindstring · required

one of live, sandbox

workspace_statestring · required

one of sandbox_only, unverified, verifying, live, restricted, suspended, closed, sandbox

parent_tenant_idstring · optional
copied_from_tenant_idstring · optional
template_keystring · optional
closed_atstring · optional · nullable
deletion_due_atstring · optional · nullable
country_codestring · optional
localestring · required
currencystring · required
timezonestring · required

Errors 401 · 403 · 409

Permissions business:organization:read · Roles: admin, analyst, billing_clerk, customer_service, field_reader, field_supervisor, finance, operations, owner, viewer

curl -X POST "$BUSINESS_API/workspace/close/reverse" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "tenant": {
    "id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
    "owner_organization_id": "own_2Hj8Qbz4glBOQR5aWPneq1JWux7",
    "slug": "slug",
    "name": "Ana Matsinhe",
    "status": "provisioning",
    "kind": "live",
    "workspace_state": "sandbox_only",
    "parent_tenant_id": "par_21NQMtrA6ldIklFucB3eoRxCqDB",
    "copied_from_tenant_id": "cop_2sEl3AsnbMmfvSknXeeX3YMH7WK",
    "template_key": "template key",
    "closed_at": "2026-11-19T09:30:00Z",
    "deletion_due_at": "2026-11-19T09:30:00Z",
    "country_code": "MZ",
    "locale": "pt",
    "currency": "MZN",
    "timezone": "Africa/Maputo"
  }
}