Generate Access Code

POST/web/v1/workspaces/{workspaceId}/institutions/{institutionBizId}/portals/portal-types/{portalType}/access-code/generate WEB

Generates a new access code for the specified portal type. If an access code already exists, it will be replaced.

Required Headers

Header	Example Value	Description
Content-Type	application/json	Request content type
Accept	application/json	Expected response type
X-Client-Hash		Client device fingerprint
Accept-Language	en, zh, zh-Hant, ja, vi	Response language (default: en)
Authorization	Bearer	JWT access token

Request Parameters

Path Parameters

Name	Type	Required	In	Description
workspaceId	string	Required	path	Workspace business ID
institutionBizId	string	Required	path	Institution business ID
portalType	integer	Required	path	Portal type code (e.g., 10010101=system, 10010102=tenant)

Success Response

Success 200

{
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "accessCode": "pac_xxxx1234abcd",
    "institutionBizId": "inst_abc123",
    "portalType": 10010102,
    "expiresAt": "2026-06-21T00:00:00Z",
    "rotatingCode": null,
    "rotatingCodeExpiresAt": null
  }
}

Error Responses

Code	Description
4010	Unauthorized (invalid or missing JWT token)
4040	Portal not found

Notes

• The newly generated access code is returned unmasked in the response.
• Previous access codes are invalidated upon generation.