Skip to content

Create Institution

POST/web/v1/workspaces/{workspaceId}/institutionsWEB

Creates a new institution under the specified workspace.

Authentication

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

Request Parameters

Path Parameters

NameTypeRequiredInDescription
workspaceIdstringYespathWorkspace business ID

Request Body

UserInstitutionCreateRequest:

NameTypeRequiredInDescription
institutionNamestringYesbodyInstitution name (max 126 characters)
institutionDescriptionstringNobodyInstitution description (max 255 characters)
institutionRemarkstringNobodyInstitution remark (max 255 characters)
institutionTypestringYesbodyInstitution type enum: SYSTEM, TENANT, PARTNER, CONSUMER
extraConfigobjectNobodyExtra configuration containing official profile and social media info
extraConfig.officialobjectNobodyOfficial business profile (name, website, email, phone, address, description)
extraConfig.socialobjectNobodySocial media contacts (telegram, whatsApp, discord, twitter)

Success Response

Success200
{
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "bizId": "inst_abc123",
    "institutionName": "Acme Corp",
    "institutionDescription": "Main institution",
    "institutionRemark": null,
    "institutionType": "TENANT",
    "institutionStatus": "ACTIVE",
    "extraConfig": null,
    "createdAt": "2026-03-21T00:00:00Z",
    "updatedAt": "2026-03-21T00:00:00Z"
  }
}

Error Responses

CodeDescription
4000Validation error (missing required fields, invalid institution type)
4010Unauthorized (invalid or missing JWT token)

Notes

  • The bizId is auto-generated by the system.
  • institutionStatus is set to the initial status upon creation.
  • createdBy and updatedBy are populated from the security context.

Internal Documentation