Skip to content

Create Portal

POST/web/v1/workspaces/{workspaceId}/institutions/{institutionBizId}/portalsWEB

Creates a new portal entry for the specified institution.

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

InstitutionPortalCreateRequest:

NameTypeRequiredInDescription
portalTypeintegerYesbodyPortal type code (e.g., 10010101=system, 10010102=tenant, 10010103=partner, 10010104=consumer)
domainstringYesbodyPortal domain URL (max 255 characters)
remarkstringNobodyPortal remark (max 255 characters)

Success Response

Success200
{
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "id": 1,
    "institutionBizId": "inst_abc123",
    "portalType": 10010102,
    "domain": "https://tenant.example.com",
    "portalStatus": 10080101,
    "remark": null,
    "createdAt": "2026-03-21T00:00:00Z",
    "updatedAt": "2026-03-21T00:00:00Z"
  }
}

Error Responses

CodeDescription
4000Validation error (missing portalType or domain)
4010Unauthorized (invalid or missing JWT token)
4040Institution not found

Notes

  • Portal status is set to ACTIVE by default upon creation.

Internal Documentation