Obter os requisitos de verificação
RegistosGET /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.
Devolve
200 Requirement progress and capability states for the active workspace
Mostrar atributos
statusverification_requirementscatalogMostrar atributos filhos
keylabel_keylabelsLocalized labels for configured custom requirements.
applies_tochecked_by
requirementsMostrar atributos filhos
currently_dueeventually_duepast_duepending_verificationerrorsMostrar atributos filhos
requirementcodeum de
information_requested,document_rejectedreason
capabilitiesMostrar atributos filhos
configureum de
inactive,pending,active,restrictedcustomersum de
inactive,pending,active,restrictedmetersum de
inactive,pending,active,restricteddraft_billingum de
inactive,pending,active,restrictedinvoicesum de
inactive,pending,active,restrictedpaymentsum de
inactive,pending,active,restrictedmessagesum de
inactive,pending,active,restrictedpublic_profileum de
inactive,pending,active,restrictedcustom_domainum de
inactive,pending,active,restrictedlive_apium de
inactive,pending,active,restrictedsandboxum de
inactive,pending,active,restrictedbillingum de
inactive,pending,active,restrictedfield_operationsum de
inactive,pending,active,restrictedstatesreasonsActionable reason for each non-active capability.
Erros 401
Permissões business:onboarding:read · Funções: admin, owner
curl -X GET "$BUSINESS_API/workspace/verification/requirements" \
-H "Authorization: Bearer sk_test_..."
# Sem comando CLI equivalente; use cURL ou HTTP directo.
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"
]
}
}
}
}