Get workspace verification requirements
LogsGET /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
statusverification_requirementscatalogShow child attributes
keylabel_keylabelsLocalized labels for configured custom requirements.
applies_tochecked_by
requirementsShow child attributes
currently_dueeventually_duepast_duepending_verificationerrorsShow child attributes
requirementcodeone of
information_requested,document_rejectedreason
capabilitiesShow child attributes
configureone of
inactive,pending,active,restrictedcustomersone of
inactive,pending,active,restrictedmetersone of
inactive,pending,active,restricteddraft_billingone of
inactive,pending,active,restrictedinvoicesone of
inactive,pending,active,restrictedpaymentsone of
inactive,pending,active,restrictedmessagesone of
inactive,pending,active,restrictedpublic_profileone of
inactive,pending,active,restrictedcustom_domainone of
inactive,pending,active,restrictedlive_apione of
inactive,pending,active,restrictedsandboxone of
inactive,pending,active,restrictedbillingone of
inactive,pending,active,restrictedfield_operationsone of
inactive,pending,active,restrictedstatesreasonsActionable 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_..."
# No matching CLI command; use cURL or direct HTTP.
const res = await fetch("$BUSINESS_API/workspace/verification/requirements", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/workspace/verification/requirements",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/workspace/verification/requirements", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"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"
]
}
}
}
}