Skip to content

Get Primary Access Code

GET/web/v1/workspaces/{workspaceId}/institutions/{institutionBizId}/portals/portal-types/{portalType}/access-code/primaryWEB

Retrieves the primary (active) access code for a specific portal type. Returns the masked access code.

Authentication

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

Request Parameters

Path Parameters

NameTypeRequiredInDescription
workspaceIdstringYespathWorkspace business ID
institutionBizIdstringYespathInstitution business ID
portalTypeintegerYespathPortal type code (e.g., 10010101=system, 10010102=tenant)

Success Response

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

Error Responses

CodeDescription
4010Unauthorized (invalid or missing JWT token)
4040Portal or primary access code not found

Notes

  • Unlike the general access code endpoint, this returns only the primary (non-rotating) access code.

Internal Documentation