API reference descriptions are provided in English to preserve the exact published contract.
GET /v1/accounts/{AC}/onboarding-cases
Required scope: `accounts:read`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes | Account SID |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
POST /v1/accounts/{AC}/onboarding-cases
Opens an onboarding case. You keep your own WhatsApp Business Account and Meta bills you directly; we prepare and submit what a Tech Provider may, and track the rest. The one-time fee as it stands today is recorded on the case and charged when we take it on, from your live wallet. One open case per account scope. Required scope: `accounts:write`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes | Account SID |
| Name | Type | Required | Description |
|---|---|---|---|
acceptFee | boolean | yes | |
acceptedFee | object | yes | |
acceptedFee.amountMinor | string (pattern ^[0-9]+$) | yes | |
acceptedFee.currency | string (pattern ^[A-Z]{3}$) | yes | |
acceptedFee.scale | integer (0–9) | yes | |
businessName | string (max 200 chars) | yes | |
contactEmail | string (max 320 chars) | yes | |
contactName | string (max 200 chars) | yes | |
handoverPhoneNumber | string (pattern ^\+[1-9][0-9]{6,14}$) | yes | |
instruction | string (max 2000 chars) | yes | |
onboardingPhoneNumber | string (pattern ^\+[1-9][0-9]{6,14}$) | yes |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
GET /v1/accounts/{AC}/onboarding-cases/{OC}
Required scope: `accounts:read`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes | |
OC | path · string (OC… SID) | yes |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
PATCH /v1/accounts/{AC}/onboarding-cases/{OC}
Required scope: `accounts:write`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes | |
OC | path · string (OC… SID) | yes |
| Name | Type | Required | Description |
|---|---|---|---|
handoverPhoneNumber | string (pattern ^\+[1-9][0-9]{6,14}$) | yes | |
onboardingPhoneNumber | string (pattern ^\+[1-9][0-9]{6,14}$) | yes |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.