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

  • Do not send a bearer token. All endpoints in this onboarding flow are public and unauthenticated.
  • Provide the record IDs required by the endpoint you call. Each endpoint page lists its required IDs.

Errors

StatusMeaning

| 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

MethodEndpointDescription
POSTInitiate signup (create/resume activation + email OTP)Step 1 of self-service signup.
POSTSave account details (step 2)Step 2 of self-service signup.
POSTSave Google Business location (step 3 — Google path)Completes self-service signup on the Google path.
POSTSave manual business address (step 3 — manual path)Step 3 (manual path) of self-service signup, used when the user does not connect a Google Business Profile.
POSTSubmit multi-location interest form (lead capture)Public lead-capture form for prospects with multiple locations.