Obter a adesão
RegistosGET /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.
Devolve
200 Application with computed requirements, capabilities and documents
Mostrar atributos
idtenant_idstatusum de
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_atrequirementsMostrar atributos filhos
currently_dueeventually_duepast_duepending_verificationerrorsMostrar atributos filhos
requirementcodeum de
information_requested,document_rejectedreason
verification_requirementscapabilitiesMostrar 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.
documentsMostrar atributos filhos
idtypeum de
incorporation,tax_certificate,concession_licence,representative_idfile_namecontent_typesize_bytesstatusum de
pending,accepted,rejectedrejection_reason
current_terms_versionhistoryReview events, on platform responses only
Mostrar atributos filhos
actoractiondetailcreated_at
Permissões business:onboarding:read · Funções: admin, owner
curl -X GET "$BUSINESS_API/onboarding" \
-H "Authorization: Bearer sk_test_..."
# Sem comando CLI equivalente; use cURL ou HTTP directo.
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"
}
]
}