Skip to content

Create Tenant Admin Init

POST/web/v1/workspaces/{workspaceId}/institutions/{institutionBizId}/admin-initWEB

Initiates the tenant admin invitation flow for a given institution. Sends an invitation email to the specified administrator.

Authentication

Requires a valid JWT token. Gateway validation: enableJwtToken=true, enableTurnstile=false.

Request Parameters

Path Parameters

NameTypeRequiredInDescription
workspaceIdstringYespathWorkspace business ID
institutionBizIdstringYespathInstitution business ID

Request Body

TenantAdminInitRequest:

NameTypeRequiredInDescription
emailstringYesbodyAdmin email address (max 255 characters, must be valid email format)
namestringNobodyAdmin display name (2-126 characters)
phonestringNobodyAdmin phone number (E.164 format, max 25 characters)

Success Response

Success200
{
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "institutionBizId": "inst_abc123",
    "email": "admin@example.com",
    "sessionId": "sess_xyz789",
    "expiresAt": "2026-03-22T00:00:00Z",
    "created": true,
    "emailSent": true
  }
}

Error Responses

CodeDescription
4000Validation error (invalid email format, name too short/long)
4010Unauthorized (invalid or missing JWT token)
4040Institution not found

Notes

  • If a pending init record already exists for the same email, created will be false and the invitation email is resent.
  • The sessionId can be used to track the initialization flow.
  • The expiresAt field indicates when the session will expire.

Internal Documentation