Get business onboarding
LogsGET /onboarding
Get the utility onboarding application, created on first read
Returns the tenant's onboarding application with its status, the requirements currently due, pending verification and satisfied, any information requests from reviewers, and the capabilities the tenant has. If the tenant has no application yet, one is created in not_started status. Requires the business:onboarding:read permission.
Returns
200 Application with computed requirements, capabilities and documents
Show attributes
idtenant_idstatusone of
not_started,in_progress,submitted,under_review,action_required,approved,rejectedbusiness_profilerepresentativecollection_channelssettlement_accounttermsrejection_reasoncustom_requirement_evidencesubmitted_atapplicant_nameThe applicant utility's name as given at sign-up or invitation; on platform reads only
reviewed_atrequirementsShow child attributes
currently_dueeventually_duepast_duepending_verificationerrorsShow child attributes
requirementcodeone of
information_requested,document_rejectedreason
verification_requirementscapabilitiesShow 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.
documentsShow child attributes
idtypeone of
incorporation,tax_certificate,concession_licence,representative_idfile_namecontent_typesize_bytesstatusone of
pending,accepted,rejectedrejection_reason
current_terms_versionhistoryReview events, on platform responses only
Show child attributes
actoractiondetailcreated_at
Permissions business:onboarding:read · Roles: admin, owner
curl -X GET "$BUSINESS_API/onboarding" \
-H "Authorization: Bearer sk_test_..."
# No matching CLI command; use cURL or direct HTTP.
const res = await fetch("$BUSINESS_API/onboarding", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/onboarding",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/onboarding", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"id": "onb_2Q6dzKEzZcYlDE2ZR0Q99qW1JoE",
"tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
"status": "not_started",
"business_profile": {},
"representative": {},
"collection_channels": [
{}
],
"settlement_account": {},
"terms": {},
"rejection_reason": "rejection reason",
"custom_requirement_evidence": {
"key": {
"value": "value",
"status": "submitted",
"reason": "Leitura confirmada no local."
}
},
"submitted_at": "2026-11-19T09:30:00Z",
"applicant_name": "Ana Matsinhe",
"reviewed_at": "2026-11-19T09:30:00Z",
"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."
}
]
},
"verification_requirements": [
"verification requirement"
],
"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"
]
}
}
},
"documents": [
{
"id": "onb_2trMqh7CG1RYcPnI4f34YJd6q9z",
"type": "incorporation",
"file_name": "Ana Matsinhe",
"content_type": "content type",
"size_bytes": 1,
"status": "pending",
"rejection_reason": "rejection reason"
}
],
"current_terms_version": "current terms version",
"history": [
{
"actor": "actor",
"action": "action",
"detail": "detail",
"created_at": "2026-11-19T09:30:00Z"
}
]
}