Register Client Publicly (v1)
Method & Path
POST /api/v1/workspace/public/client-registration/:token
Actual backend path: /v1/workspace/public/client-registration/:token
Description
Creates a workspace Client from the public self-registration form and consumes the one-time invite. A second submission with the same token returns 409 Conflict.
Authentication
None (public).
Persona access: Customer (unauthenticated).
Headers
| Header | Type | Required | Description |
|---|---|---|---|
Content-Type | string | Yes | application/json |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token | string | Yes | One-time registration token |
Request Body
{
"name": "Sara Ahmad",
"phone": "0599000000",
"email": "sara@example.com",
"gender": "female",
"dateOfBirth": "1995-01-20"
}
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Client full name |
phone | string | Yes | Preferred phone contact |
email | string | null | No | Optional email contact |
gender | male | female | null | No | Optional gender |
dateOfBirth | string | null | No | Optional ISO date |
Response 201 Created
{
"client": {
"id": "507f1f77bcf86cd799439011",
"name": "Sara Ahmad",
"workspaceName": "Randerma"
}
}
Common Errors
- 409 Conflict: Link already used (details may include
registeredName) - 404 Not Found: Invalid token
- 422 Unprocessable Entity: Validation failed
- 500 Internal Server Error: Unexpected server error