Sign-up
1 operation in the Tolvi API, version 1. Paths are relative to https://api.tolvi.co.uk. Every amount is integer pence.
Sign a new firm up
POST/api/v1/signup
- Access
- No authentication.
Creates the firm and its sign-in organisation, and emails the founder a single-use link. Following it confirms the address, has them choose a password and makes them the firm’s owner. No token needed. 503 when this server has no identity-provider Management API.
Request body
Required. application/json: object (SignUpRequest).
| Field | Type | Description |
|---|---|---|
firmNamerequired | string | 1 to 200 characters; example "Alder & Co" |
emailrequired | string (email) | The founder’s work email. They become the firm’s owner. up to 254 characters |
marketingConsent | boolean | The founder opted in to Tolvi marketing email (an unticked box on the form; MARKETING_CONSENT_TEXT). Recorded with the wording version and time. Trial emails about the account are sent either way. default false |
Responses
202 Accepted, application/json
Body: object (SignUpResult).
| Field | Type | Description |
|---|---|---|
emailrequired | string (email) | Where the link to finish signing up was sent. |
403 Forbidden
Sign-up is closed: people join by invitation (TOLVI_SIGNUP_OPEN is off).
Errors: 400 Bad request, 429 Too many requests, as problem details (application/problem+json).