Signup
Public, unauthenticated self-service onboarding wizard (no bearer token).
Public, unauthenticated self-service onboarding wizard (no bearer token). Step 1 POST /signup creates or resumes a signup activation and emails an OTP. Step 2 POST /signup/account saves the account holder's name/password/contact. Step 3 POST /signup/account/business (Google Business Profile path) or POST /signup/account/business/info (manual address path) attaches the business location and provisions the company/store/plan and marks the activation Active. POST /signup/multi-location-signup is a separate reCAPTCHA-gated lead-capture form for multi-location prospects (records the enquiry only, no account). All routes throttle at 10/min per IP.
Prerequisites
- Most endpoints require a bearer token in the
Authorizationheader. The signup and multi-location endpoints listed below require no token. - The id of each record the call targets. Every endpoint page lists the ids it needs.
Errors
| Status | Meaning |
|---|---|
401 | The bearer token is missing, expired or invalid |
403 | The token is valid but the record sits outside your account |
422 | The request failed validation — the response names the fields |
500 | Unexpected server error |
Individual endpoints may return more; each page lists its own.
Endpoints
POST — Completes self-service signup on the Google path.
POST — Step 3 (manual path) of self-service signup, used when the user does not connect a Google Business Profile.
POST — Public lead-capture form for prospects with multiple locations.
Updated 15 days ago