PT EN

Adesão

URL base: $BUSINESS_API

O objecto

idstring · opcional
tenant_idstring · opcional
statusstring · opcional

um de not_started, in_progress, submitted, under_review, action_required, approved, rejected

business_profileobject · opcional
representativeobject · opcional
collection_channelsarray of object · opcional
settlement_accountobject · opcional
termsobject · opcional
rejection_reasonstring · opcional
custom_requirement_evidenceobject · opcional
submitted_atstring (date-time) · opcional
applicant_namestring · opcional

The applicant utility's name as given at sign-up or invitation; on platform reads only

reviewed_atstring (date-time) · opcional
requirementsobject · opcional
Mostrar atributos filhos
currently_duearray of string · opcional
eventually_duearray of string · opcional
past_duearray of string · opcional
pending_verificationarray of string · opcional
errorsarray of object · opcional
Mostrar atributos filhos
requirementstring · opcional
codestring · opcional

um de information_requested, document_rejected

reasonstring · opcional
verification_requirementsarray of string · opcional
capabilitiesobject · opcional
Mostrar atributos filhos
configurestring · opcional

um de inactive, pending, active, restricted

customersstring · opcional

um de inactive, pending, active, restricted

metersstring · opcional

um de inactive, pending, active, restricted

draft_billingstring · opcional

um de inactive, pending, active, restricted

invoicesstring · opcional

um de inactive, pending, active, restricted

paymentsstring · opcional

um de inactive, pending, active, restricted

messagesstring · opcional

um de inactive, pending, active, restricted

public_profilestring · opcional

um de inactive, pending, active, restricted

custom_domainstring · opcional

um de inactive, pending, active, restricted

live_apistring · opcional

um de inactive, pending, active, restricted

sandboxstring · opcional

um de inactive, pending, active, restricted

billingstring · opcional

um de inactive, pending, active, restricted

field_operationsstring · opcional

um de inactive, pending, active, restricted

statesobject · opcional
reasonsobject · opcional

Actionable reason for each non-active capability.

documentsarray of OnboardingDocument · opcional
Mostrar atributos filhos
idstring · opcional
typestring · opcional

um de incorporation, tax_certificate, concession_licence, representative_id

file_namestring · opcional
content_typestring · opcional
size_bytesinteger · opcional
statusstring · opcional

um de pending, accepted, rejected

rejection_reasonstring · opcional
current_terms_versionstring · opcional
historyarray of object · opcional

Review events, on platform responses only

Mostrar atributos filhos
actorstring · opcional
actionstring · opcional
detailstring · opcional
created_atstring (date-time) · opcional
O objecto
{
  "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"
    }
  ]
}

Obter a adesão

Registos

GET /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
idstring · opcional
tenant_idstring · opcional
statusstring · opcional

um de not_started, in_progress, submitted, under_review, action_required, approved, rejected

business_profileobject · opcional
representativeobject · opcional
collection_channelsarray of object · opcional
settlement_accountobject · opcional
termsobject · opcional
rejection_reasonstring · opcional
custom_requirement_evidenceobject · opcional
submitted_atstring (date-time) · opcional
applicant_namestring · opcional

The applicant utility's name as given at sign-up or invitation; on platform reads only

reviewed_atstring (date-time) · opcional
requirementsobject · opcional
Mostrar atributos filhos
currently_duearray of string · opcional
eventually_duearray of string · opcional
past_duearray of string · opcional
pending_verificationarray of string · opcional
errorsarray of object · opcional
Mostrar atributos filhos
requirementstring · opcional
codestring · opcional

um de information_requested, document_rejected

reasonstring · opcional
verification_requirementsarray of string · opcional
capabilitiesobject · opcional
Mostrar atributos filhos
configurestring · opcional

um de inactive, pending, active, restricted

customersstring · opcional

um de inactive, pending, active, restricted

metersstring · opcional

um de inactive, pending, active, restricted

draft_billingstring · opcional

um de inactive, pending, active, restricted

invoicesstring · opcional

um de inactive, pending, active, restricted

paymentsstring · opcional

um de inactive, pending, active, restricted

messagesstring · opcional

um de inactive, pending, active, restricted

public_profilestring · opcional

um de inactive, pending, active, restricted

custom_domainstring · opcional

um de inactive, pending, active, restricted

live_apistring · opcional

um de inactive, pending, active, restricted

sandboxstring · opcional

um de inactive, pending, active, restricted

billingstring · opcional

um de inactive, pending, active, restricted

field_operationsstring · opcional

um de inactive, pending, active, restricted

statesobject · opcional
reasonsobject · opcional

Actionable reason for each non-active capability.

documentsarray of OnboardingDocument · opcional
Mostrar atributos filhos
idstring · opcional
typestring · opcional

um de incorporation, tax_certificate, concession_licence, representative_id

file_namestring · opcional
content_typestring · opcional
size_bytesinteger · opcional
statusstring · opcional

um de pending, accepted, rejected

rejection_reasonstring · opcional
current_terms_versionstring · opcional
historyarray of object · opcional

Review events, on platform responses only

Mostrar atributos filhos
actorstring · opcional
actionstring · opcional
detailstring · opcional
created_atstring (date-time) · opcional

Permissões business:onboarding:read · Funções: admin, owner

curl -X GET "$BUSINESS_API/onboarding" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200
{
  "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"
    }
  ]
}

Actualizar a adesão

Registos

PATCH /onboarding

Partially update onboarding sections, validated field by field

Updates only the sections and fields sent (business profile, representative, collection channels, settlement account, terms acceptance) and returns the recomputed application; a not_started application moves to in_progress. Fields that fail validation are all reported in one 400 response, and updating a field clears the reviewer's information request for it. Returns 409 when the application is not editable; an approved application may still change payment details or correct its tax number.

Corpo application/json

business_profileobject · opcional
Mostrar atributos filhos
legal_namestring · opcional
trading_namestring · opcional
nuitstring · opcional

Nine-digit Mozambican NUIT including the Modulo 11 check digit

registration_numberstring · opcional
addressstring · opcional
licence_referencestring · opcional
phonestring · opcional
support_contactstring · opcional

E-mail or phone

representativeobject · opcional
Mostrar atributos filhos
namestring · opcional
rolestring · opcional
id_document_numberstring · opcional
date_of_birthstring (date) · opcional
contactstring · opcional
collection_channelsarray of object · opcional
Mostrar atributos filhos
typestring · obrigatório

One of collection_channel_types.

referencestring · obrigatório
collection_channel_typesarray of string · opcional

The channel types the server accepts; configuration forms offer these.

settlement_accountobject · opcional
Mostrar atributos filhos
bankstring · opcional
account_holderstring · opcional
account_numberstring · opcional

21-digit NIB or IBAN; returned masked

termsobject · opcional
Mostrar atributos filhos
acceptedboolean · obrigatório
versionstring · obrigatório

Must equal current_terms_version

Devolve

200 Updated application

Mostrar atributos
idstring · opcional
tenant_idstring · opcional
statusstring · opcional

um de not_started, in_progress, submitted, under_review, action_required, approved, rejected

business_profileobject · opcional
representativeobject · opcional
collection_channelsarray of object · opcional
settlement_accountobject · opcional
termsobject · opcional
rejection_reasonstring · opcional
custom_requirement_evidenceobject · opcional
submitted_atstring (date-time) · opcional
applicant_namestring · opcional

The applicant utility's name as given at sign-up or invitation; on platform reads only

reviewed_atstring (date-time) · opcional
requirementsobject · opcional
Mostrar atributos filhos
currently_duearray of string · opcional
eventually_duearray of string · opcional
past_duearray of string · opcional
pending_verificationarray of string · opcional
errorsarray of object · opcional
Mostrar atributos filhos
requirementstring · opcional
codestring · opcional

um de information_requested, document_rejected

reasonstring · opcional
verification_requirementsarray of string · opcional
capabilitiesobject · opcional
Mostrar atributos filhos
configurestring · opcional

um de inactive, pending, active, restricted

customersstring · opcional

um de inactive, pending, active, restricted

metersstring · opcional

um de inactive, pending, active, restricted

draft_billingstring · opcional

um de inactive, pending, active, restricted

invoicesstring · opcional

um de inactive, pending, active, restricted

paymentsstring · opcional

um de inactive, pending, active, restricted

messagesstring · opcional

um de inactive, pending, active, restricted

public_profilestring · opcional

um de inactive, pending, active, restricted

custom_domainstring · opcional

um de inactive, pending, active, restricted

live_apistring · opcional

um de inactive, pending, active, restricted

sandboxstring · opcional

um de inactive, pending, active, restricted

billingstring · opcional

um de inactive, pending, active, restricted

field_operationsstring · opcional

um de inactive, pending, active, restricted

statesobject · opcional
reasonsobject · opcional

Actionable reason for each non-active capability.

documentsarray of OnboardingDocument · opcional
Mostrar atributos filhos
idstring · opcional
typestring · opcional

um de incorporation, tax_certificate, concession_licence, representative_id

file_namestring · opcional
content_typestring · opcional
size_bytesinteger · opcional
statusstring · opcional

um de pending, accepted, rejected

rejection_reasonstring · opcional
current_terms_versionstring · opcional
historyarray of object · opcional

Review events, on platform responses only

Mostrar atributos filhos
actorstring · opcional
actionstring · opcional
detailstring · opcional
created_atstring (date-time) · opcional

Erros 400 · 409

Permissões business:onboarding:write · Funções: admin, owner

curl -X PATCH "$BUSINESS_API/onboarding" \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "business_profile": {
    "legal_name": "Ana Matsinhe",
    "trading_name": "Ana Matsinhe",
    "nuit": "400123456",
    "registration_number": "REG-2026-000142",
    "address": "Av. Julius Nyerere 1420, Maputo",
    "licence_reference": "LIC-2026-000142",
    "phone": "+258841234567",
    "support_contact": "support contact"
  },
  "representative": {
    "name": "Ana Matsinhe",
    "role": "role",
    "id_document_number": "IDD-2026-000142",
    "date_of_birth": "2026-11-19",
    "contact": "contact"
  },
  "collection_channels": [
    {
      "type": "active",
      "reference": "REF-2026-000142"
    }
  ],
  "collection_channel_types": [
    "collection channel type"
  ],
  "settlement_account": {
    "bank": "bank",
    "account_holder": "account holder",
    "account_number": "ACC-2026-000142"
  },
  "terms": {
    "accepted": true,
    "version": "version"
  }
}'
Resposta 200
{
  "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"
    }
  ]
}

Submeter a adesão para análise

Registos

POST /onboarding/submit

Moves the application to submitted so the platform can review it, records the submission time and returns the updated application. Returns 409 listing every outstanding requirement while anything is currently due, and 409 when the application is not in not_started, in_progress or action_required. Requires the business:onboarding:submit permission.

Devolve

200 Submitted application

Mostrar atributos
idstring · opcional
tenant_idstring · opcional
statusstring · opcional

um de not_started, in_progress, submitted, under_review, action_required, approved, rejected

business_profileobject · opcional
representativeobject · opcional
collection_channelsarray of object · opcional
settlement_accountobject · opcional
termsobject · opcional
rejection_reasonstring · opcional
custom_requirement_evidenceobject · opcional
submitted_atstring (date-time) · opcional
applicant_namestring · opcional

The applicant utility's name as given at sign-up or invitation; on platform reads only

reviewed_atstring (date-time) · opcional
requirementsobject · opcional
Mostrar atributos filhos
currently_duearray of string · opcional
eventually_duearray of string · opcional
past_duearray of string · opcional
pending_verificationarray of string · opcional
errorsarray of object · opcional
Mostrar atributos filhos
requirementstring · opcional
codestring · opcional

um de information_requested, document_rejected

reasonstring · opcional
verification_requirementsarray of string · opcional
capabilitiesobject · opcional
Mostrar atributos filhos
configurestring · opcional

um de inactive, pending, active, restricted

customersstring · opcional

um de inactive, pending, active, restricted

metersstring · opcional

um de inactive, pending, active, restricted

draft_billingstring · opcional

um de inactive, pending, active, restricted

invoicesstring · opcional

um de inactive, pending, active, restricted

paymentsstring · opcional

um de inactive, pending, active, restricted

messagesstring · opcional

um de inactive, pending, active, restricted

public_profilestring · opcional

um de inactive, pending, active, restricted

custom_domainstring · opcional

um de inactive, pending, active, restricted

live_apistring · opcional

um de inactive, pending, active, restricted

sandboxstring · opcional

um de inactive, pending, active, restricted

billingstring · opcional

um de inactive, pending, active, restricted

field_operationsstring · opcional

um de inactive, pending, active, restricted

statesobject · opcional
reasonsobject · opcional

Actionable reason for each non-active capability.

documentsarray of OnboardingDocument · opcional
Mostrar atributos filhos
idstring · opcional
typestring · opcional

um de incorporation, tax_certificate, concession_licence, representative_id

file_namestring · opcional
content_typestring · opcional
size_bytesinteger · opcional
statusstring · opcional

um de pending, accepted, rejected

rejection_reasonstring · opcional
current_terms_versionstring · opcional
historyarray of object · opcional

Review events, on platform responses only

Mostrar atributos filhos
actorstring · opcional
actionstring · opcional
detailstring · opcional
created_atstring (date-time) · opcional

Erros 409

Permissões business:onboarding:submit · Funções: admin, owner

curl -X POST "$BUSINESS_API/onboarding/submit" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200
{
  "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"
    }
  ]
}

Submeter um requisito de adesão

Registos

POST /onboarding/requirements/{key}

Submit text evidence for a configured manual verification requirement

Stores the given text value (1 to 4000 characters) as evidence for a manual-review requirement configured in the verification catalog and marks it submitted for platform review. Returns 400 when the key is not a manual requirement or is not required for this tenant, and 409 when the requirement is already verified or the application is submitted or under review.

Parâmetros

keystring · caminho · obrigatório

Key of a manual-review requirement from the verification catalog, in the form custom.<name> where the name uses lower-case letters, digits, dots, underscores and hyphens, up to 80 characters in total.

Corpo application/json

valuestring · obrigatório

Devolve

200 Application with submitted evidence state

Mostrar atributos
idstring · opcional
tenant_idstring · opcional
statusstring · opcional

um de not_started, in_progress, submitted, under_review, action_required, approved, rejected

business_profileobject · opcional
representativeobject · opcional
collection_channelsarray of object · opcional
settlement_accountobject · opcional
termsobject · opcional
rejection_reasonstring · opcional
custom_requirement_evidenceobject · opcional
submitted_atstring (date-time) · opcional
applicant_namestring · opcional

The applicant utility's name as given at sign-up or invitation; on platform reads only

reviewed_atstring (date-time) · opcional
requirementsobject · opcional
Mostrar atributos filhos
currently_duearray of string · opcional
eventually_duearray of string · opcional
past_duearray of string · opcional
pending_verificationarray of string · opcional
errorsarray of object · opcional
Mostrar atributos filhos
requirementstring · opcional
codestring · opcional

um de information_requested, document_rejected

reasonstring · opcional
verification_requirementsarray of string · opcional
capabilitiesobject · opcional
Mostrar atributos filhos
configurestring · opcional

um de inactive, pending, active, restricted

customersstring · opcional

um de inactive, pending, active, restricted

metersstring · opcional

um de inactive, pending, active, restricted

draft_billingstring · opcional

um de inactive, pending, active, restricted

invoicesstring · opcional

um de inactive, pending, active, restricted

paymentsstring · opcional

um de inactive, pending, active, restricted

messagesstring · opcional

um de inactive, pending, active, restricted

public_profilestring · opcional

um de inactive, pending, active, restricted

custom_domainstring · opcional

um de inactive, pending, active, restricted

live_apistring · opcional

um de inactive, pending, active, restricted

sandboxstring · opcional

um de inactive, pending, active, restricted

billingstring · opcional

um de inactive, pending, active, restricted

field_operationsstring · opcional

um de inactive, pending, active, restricted

statesobject · opcional
reasonsobject · opcional

Actionable reason for each non-active capability.

documentsarray of OnboardingDocument · opcional
Mostrar atributos filhos
idstring · opcional
typestring · opcional

um de incorporation, tax_certificate, concession_licence, representative_id

file_namestring · opcional
content_typestring · opcional
size_bytesinteger · opcional
statusstring · opcional

um de pending, accepted, rejected

rejection_reasonstring · opcional
current_terms_versionstring · opcional
historyarray of object · opcional

Review events, on platform responses only

Mostrar atributos filhos
actorstring · opcional
actionstring · opcional
detailstring · opcional
created_atstring (date-time) · opcional

Erros 400 · 401 · 409

Permissões business:onboarding:write · Funções: admin, owner

curl -X POST "$BUSINESS_API/onboarding/requirements/{key}" \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "value": "value"
}'
Resposta 200
{
  "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"
    }
  ]
}

Listar documentos da adesão

Registos

GET /onboarding/documents

Returns, under data, every document uploaded for the tenant's onboarding application with its type, file name, content type, size and review status. The file contents are not included; use the file download operation for that. Requires the business:onboarding:read permission.

Devolve

200 Documents

Mostrar atributos
dataarray of OnboardingDocument · opcional
Mostrar atributos filhos
idstring · opcional
typestring · opcional

um de incorporation, tax_certificate, concession_licence, representative_id

file_namestring · opcional
content_typestring · opcional
size_bytesinteger · opcional
statusstring · opcional

um de pending, accepted, rejected

rejection_reasonstring · opcional

Permissões business:onboarding:read · Funções: admin, owner

curl -X GET "$BUSINESS_API/onboarding/documents" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200
{
  "data": [
    {
      "id": "onb_2trMqh7CG1RYcPnI4f34YJd6q9z",
      "type": "incorporation",
      "file_name": "Ana Matsinhe",
      "content_type": "content type",
      "size_bytes": 1,
      "status": "pending",
      "rejection_reason": "rejection reason"
    }
  ]
}

Carregar um documento

Registos

POST /onboarding/documents

Upload a document (PDF, JPEG or PNG, up to 10 MiB)

Accepts a multipart form with a type field (incorporation, tax_certificate, concession_licence or representative_id) and a file field, and stores the document in pending status with 201. The file type is detected from its content; anything other than PDF, JPEG or PNG returns 415, and a file over 10 MiB returns 413. Returns 409 when the application is not editable (not_started, in_progress or action_required).

Devolve

201 Stored document

Mostrar atributos
idstring · opcional
typestring · opcional

um de incorporation, tax_certificate, concession_licence, representative_id

file_namestring · opcional
content_typestring · opcional
size_bytesinteger · opcional
statusstring · opcional

um de pending, accepted, rejected

rejection_reasonstring · opcional

Erros 400 · 413 · 415

Permissões business:onboarding:write · Funções: admin, owner

curl -X POST "$BUSINESS_API/onboarding/documents" \
  -H "Authorization: Bearer sk_test_..."
Resposta 201
{
  "id": "onb_2trMqh7CG1RYcPnI4f34YJd6q9z",
  "type": "incorporation",
  "file_name": "Ana Matsinhe",
  "content_type": "content type",
  "size_bytes": 1,
  "status": "pending",
  "rejection_reason": "rejection reason"
}

Obter um documento

Registos

GET /onboarding/documents/{id}

Returns the document's type, file name, content type, size and review status without its contents. Returns 404 when the document does not exist in the caller's tenant. Requires the business:onboarding:read permission.

Parâmetros

idstring · caminho · obrigatório

Resource identifier

Devolve

200 Document

Mostrar atributos
idstring · opcional
typestring · opcional

um de incorporation, tax_certificate, concession_licence, representative_id

file_namestring · opcional
content_typestring · opcional
size_bytesinteger · opcional
statusstring · opcional

um de pending, accepted, rejected

rejection_reasonstring · opcional

Permissões business:onboarding:read · Funções: admin, owner

curl -X GET "$BUSINESS_API/onboarding/documents/{id}" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200
{
  "id": "onb_2trMqh7CG1RYcPnI4f34YJd6q9z",
  "type": "incorporation",
  "file_name": "Ana Matsinhe",
  "content_type": "content type",
  "size_bytes": 1,
  "status": "pending",
  "rejection_reason": "rejection reason"
}

Eliminar um documento

Registos

DELETE /onboarding/documents/{id}

Removes the document record and its stored file and returns 204. Returns 409 when the application is no longer editable (for example once it has been submitted), and 404 when the document does not exist. Requires the business:onboarding:write permission.

Parâmetros

idstring · caminho · obrigatório

Resource identifier

Devolve

204 Deleted

Permissões business:onboarding:write · Funções: admin, owner

curl -X DELETE "$BUSINESS_API/onboarding/documents/{id}" \
  -H "Authorization: Bearer sk_test_..."
Resposta 204

Deleted

Descarregar um documento

Registos

GET /onboarding/documents/{id}/file

Streams the stored file as an attachment with its original file name and the content type detected at upload. Returns 404 when the document or its stored file is missing. Requires the business:onboarding:read permission.

Parâmetros

idstring · caminho · obrigatório

Resource identifier

Devolve

200 File bytes

Permissões business:onboarding:read · Funções: admin, owner

curl -X GET "$BUSINESS_API/onboarding/documents/{id}/file" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200

File bytes

Obter o resumo da entrega

Registos

GET /onboarding/handover

Returns, to the invited owner only, what the platform completed (step IDs, who and when) and the outstanding real-account steps, before and after acceptance. Requires business:onboarding:read; other principals get 404.

Devolve

200 Handover summary

Mostrar atributos
invitation_idstring · obrigatório
tenant_idstring · obrigatório
utility_namestring · obrigatório
handoverobject · obrigatório
Mostrar atributos filhos
statestring · opcional

um de not_required, pending_owner_acceptance, accepted

accepted_atstring (date-time) · opcional
completedarray of object · obrigatório
Mostrar atributos filhos
step_idstring · opcional
responsibilitystring · opcional

um de platform, utility

completed_by_namestring · opcional
completed_atstring (date-time) · opcional
outstandingarray of string · obrigatório

Erros 401 · 403 · 404

curl -X GET "$BUSINESS_API/onboarding/handover" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200
{
  "invitation_id": "ivt_2pf2g1TgOrLQ0HT6IxvyElNWgBz",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "utility_name": "Ana Matsinhe",
  "handover": {
    "state": "not_required",
    "accepted_at": "2026-11-19T09:30:00Z"
  },
  "completed": [
    {
      "step_id": "service_areas",
      "responsibility": "platform",
      "completed_by_name": "Ana Matsinhe",
      "completed_at": "2026-11-19T09:30:00Z"
    }
  ],
  "outstanding": [
    "company_details",
    "documents"
  ]
}

Aceitar a entrega de uma empresa preparada pela plataforma

Registos

POST /onboarding/handover/accept

The invited owner accepts the summary: the utility becomes owner managed, the event is audited with the operator's ID and name, platform-completed steps are carried into the owner's checklist with their attribution, and the operator's setup access ends. The owner's existing session then reaches every business route without signing in again. Only the owner can call it, with business:onboarding:write. Repeating it returns the summary.

Devolve

200 Accepted handover summary

Mostrar atributos
invitation_idstring · obrigatório
tenant_idstring · obrigatório
utility_namestring · obrigatório
handoverobject · obrigatório
Mostrar atributos filhos
statestring · opcional

um de not_required, pending_owner_acceptance, accepted

accepted_atstring (date-time) · opcional
completedarray of object · obrigatório
Mostrar atributos filhos
step_idstring · opcional
responsibilitystring · opcional

um de platform, utility

completed_by_namestring · opcional
completed_atstring (date-time) · opcional
outstandingarray of string · obrigatório

Erros 401 · 403 · 404 · 409

curl -X POST "$BUSINESS_API/onboarding/handover/accept" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200
{
  "invitation_id": "ivt_2pf2g1TgOrLQ0HT6IxvyElNWgBz",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "utility_name": "Ana Matsinhe",
  "handover": {
    "state": "not_required",
    "accepted_at": "2026-11-19T09:30:00Z"
  },
  "completed": [
    {
      "step_id": "service_areas",
      "responsibility": "platform",
      "completed_by_name": "Ana Matsinhe",
      "completed_at": "2026-11-19T09:30:00Z"
    }
  ],
  "outstanding": [
    "company_details",
    "documents"
  ]
}