Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
POST /v1/firm-control/staff/invitations.
POST /v1/firm-control/staff/invitations
operationId: inviteStaff
Creates a staff relationship and optionally assigns an initial RBAC role for the firm entity.
This route attaches a known user as staff. To invite by email and have the user complete signup, use POST /v1/firm-control/users/invitations with relationship_type: "STAFF".
| Param | Required | Notes |
|---|---|---|
firm_slug | no | Override the firm scope by slug. |
| Field | Required | Notes |
|---|---|---|
user_id | yes | Existing Tradara user UUID to attach as staff. |
firm_id | no | Required when X-Firm-ID is absent. |
email | no | Reference email, stored on the relationship. |
role_name | no | RBAC role to assign on creation. |
curl -X POST "$TRADARA_BASE_URL/v1/firm-control/staff/invitations" \
-H "X-Tradara-Api-Key: $TRADARA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"user_id": "8e9ad12c-2b1c-4e9a-9d3b-5e6c7a0d1f23",
"email": "[email protected]",
"role_name": "risk_operator"
}'
201 CreatedFirmRelationship.
{
"id": "rel_01HW...",
"firm_id": "8f4a1d6e-2b1c-4e9a-9d3b-5e6c7a0d1f23",
"user_id": "8e9ad12c-2b1c-4e9a-9d3b-5e6c7a0d1f23",
"relationship_type": "STAFF",
"status": "ACTIVE",
"invited_email": "[email protected]",
"invitation_token_hash": "",
"invitation_expires_at": "",
"created_at": "2026-06-26T16:00:00Z",
"updated_at": "2026-06-26T16:00:00Z"
}
| HTTP | Meaning |
|---|---|
400 | Missing user_id, or role_name not found. |
502 | Downstream relationship/RBAC service unreachable. |