SYSTEM Portal — WEB Chain Endpoint Reference

Total endpoints: 199

Generated from verified E2E fixtures under doc-verify/data/examples/system in slaunchx-api-toolkit.

Auth

POST `/web/v1/system/auth/login/complete`

Submits auth login complete.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{
  "sessionId": "{sessionId}",
  "method": 10011001,
  "code": "JXT3R5"
}

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885035902,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "accessToken": "{token}",
    "refreshToken": "{token}",
    "expiresIn": 3600,
    "accountStatus": null,
    "pendingApproval": false
  }
}

Error Response: (HTTP 404)

json

{
  "version": "2.0.0",
  "timestamp": 1774885035907,
  "success": false,
  "code": "AUTH.SESSION_NOT_FOUND",
  "message": "Authentication session was not found",
  "data": null
}

POST `/web/v1/system/auth/login/initiate`

Submits auth login initiate.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{
  "email": "admin@slaunchx.test",
  "password": "DocVerify123!"
}

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885035470,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "sessionId": "{sessionId}",
    "mfaMethods": [
      {
        "code": "EMAIL",
        "value": 10011001,
        "label": "Email",
        "description": "Email verification code"
      }
    ],
    "expiresIn": 300,
    "accountStatus": null,
    "pendingApproval": false
  }
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885035601,
  "success": false,
  "code": "AUTH.INVALID_CREDENTIALS",
  "message": "Invalid credentials",
  "data": null
}

POST `/web/v1/system/auth/login/mfa/send`

Submits auth login mfa send.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{
  "sessionId": "{sessionId}",
  "method": 10011001
}

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885035743,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "sent": true,
    "cooldownSeconds": 60,
    "codeExpiresIn": 300
  }
}

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885035747,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/auth/logout`

Submits auth logout.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

null

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885036068,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "success": true,
    "terminatedSessions": 1
  }
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885036071,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/system/auth/password/change`

Submits auth password change.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json;charset=UTF-8	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

"{\"v\":2,\"p\":\"vcO_LhObPQnSg1Vc68oT1bfJAR_SMg8BWkRu-jGlGy4GNbt7-692-zLXRQqwJ5f4XH0GRMoRY70DlJ1FiVa-5JE891bdlnq-jdbjNkbiQflT6iZyDHZjGmuMo_TNEP9J\"}"

Success Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885046915,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885046919,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/system/auth/password/forgot`

Submits auth password forgot.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{
  "email": "admin@slaunchx.test",
  "turnstileToken": "{token}"
}

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885036083,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "success": true,
    "message": "如果邮箱存在, 将收到重置链接"
  }
}

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885036088,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/auth/password/init`

Submits auth password init.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json;charset=UTF-8	Content type

Request Body:

json

"{\"v\":2,\"p\":\"Z3hxXrTZEMFkbKEADLpxGiNr6P_RGq9KaUO1MssEu7cC5HYQ0BaSIHtgcDF9LXqqFWkEGTdMdojQ08Rz6nkZIfluRSg40PU0wV5CA0SIoi-zdMLCgZb3JlvIRZLX-snhRmBD\"}"

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885036619,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/auth/password/reset`

Submits auth password reset.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json;charset=UTF-8	Content type

Request Body:

json

"{\"v\":2,\"p\":\"efSKvOBEYShLxxRbw1tbkE5TchUq8mIHoax3OeZelCuvLVqYaV230WUwspWSz5VSOSnoJ9tIUMyc35Jb1O63F0cvPWIU05ZJtRlV_xj4bO8qcm0RzSwR\"}"

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885046731,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/auth/token/refresh`

Submits auth token refresh.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{
  "refreshToken": "{token}"
}

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885035911,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "accessToken": "{token}",
    "refreshToken": "{token}",
    "expiresIn": 3600
  }
}

Error Response: (HTTP 404)

json

{
  "version": "2.0.0",
  "timestamp": 1774885035915,
  "success": false,
  "code": "AUTH.SESSION_NOT_FOUND",
  "message": "Authentication session was not found",
  "data": null
}

Security

GET `/web/v1/system/security/ip-whitelist`

Reads security ip whitelist.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033205,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "enabled": false,
    "entries": []
  }
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033208,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

GET `/web/v1/system/security/mfa`

Reads security mfa.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033163,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "mfaMethod": {
        "code": "EMAIL",
        "value": 10011001,
        "label": "Email",
        "description": "Email verification code"
      },
      "isEnabled": true,
      "isPrimary": true,
      "verifiedAt": null
    }
  ]
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033167,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

GET `/web/v1/system/security/mfa/backup-codes`

Reads security mfa backup codes.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033182,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "remainingCount": 0,
    "totalGenerated": 10
  }
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033185,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

GET `/web/v1/system/security/sessions`

Reads security sessions.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033228,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "sessionId": "{sessionId}",
      "clientIp": "127.0.0.1",
      "userAgent": "slaunchx-doc-verify/1.0",
      "loginTime": "2026-03-30T15:37:13.156915143Z",
      "lastActivityTime": "2026-03-30T15:37:13.156915143Z",
      "isCurrent": true
    },
    {
      "sessionId": "{sessionId}",
      "clientIp": "127.0.0.1",
      "userAgent": "slaunchx-doc-verify/1.0",
      "loginTime": "2026-03-30T15:37:08.060427900Z",
      "lastActivityTime": "2026-03-30T15:37:08.060427900Z",
      "isCurrent": false
    }
  ]
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033233,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

GET `/web/v1/system/security/sessions/config`

Reads security sessions config.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033194,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "accountBizId": "qiE8ybw1ol0WRhb3",
    "ssoEnabled": true,
    "maxSessions": 3,
    "passwordChangedAt": null,
    "lastLoginAt": null,
    "lastLoginIp": null
  }
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033197,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

GET `/web/v1/system/security/sessions/history`

Reads security sessions history.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033250,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "items": [
      {
        "bizId": "lh-a891be31-a174-4376-b87f-b20a621d3d22",
        "loginTime": "2026-03-30T15:37:13.157766Z",
        "clientIp": "127.0.0.1",
        "userAgent": "slaunchx-doc-verify/1.0",
        "loginResult": 1,
        "failureReason": null
      },
      {
        "bizId": "lh-00794320-9de8-4110-bce3-6317a39ca151",
        "loginTime": "2026-03-30T15:37:08.061649Z",
        "clientIp": "127.0.0.1",
        "userAgent": "slaunchx-doc-verify/1.0",
        "loginResult": 1,
        "failureReason": null
      }
    ],
    "pagination": {
      "totalPages": 3,
      "totalRecords": 60,
      "currentPage": 1,
      "pageSize": 20,
      "hasNext": true,
      "empty": false,
      "paginated": true
    }
  }
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033253,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/system/security/ip-whitelist`

Submits security ip whitelist.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{
  "ips": [
    "127.0.0.1"
  ]
}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033211,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/system/security/ip-whitelist/disable`

Submits security ip whitelist disable.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

null

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033216,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/system/security/ip-whitelist/enable`

Submits security ip whitelist enable.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

null

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033214,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/system/security/mfa/backup-codes/generate`

Submits security mfa backup codes generate.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

null

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033189,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/system/security/mfa/otp/revoke`

Submits security mfa otp revoke.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

null

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033176,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/system/security/mfa/otp/setup`

Submits security mfa otp setup.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

null

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033169,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/system/security/mfa/otp/verify`

Submits security mfa otp verify.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033173,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/security/sessions/config`

Submits security sessions config.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{
  "maxConcurrentSessions": 5
}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033200,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/system/security/sessions/terminate`

Submits security sessions terminate.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033237,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/security/sessions/terminate-all`

Submits security sessions terminate all.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

null

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033244,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

Profile

GET `/web/v1/system/profile`

Reads profile.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885052385,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "qiE8ybw1ol0WRhb3",
    "institutionBizId": "TvL208Vd9Q8Wh3wz",
    "accountEmail": "admin@slaunchx.test",
    "accountPhone": "+10000000000",
    "accountName": "System Admin",
    "accountRemark": null,
    "accountPortal": {
      "code": "SYSTEM",
      "value": 10010101,
      "label": "System Portal",
      "description": "System-level portal for platform administrators"
    },
    "accountStatus": {
      "code": "ACTIVE",
      "value": 10010202,
      "label": "Active",
      "description": "Account is active and usable"
    },
    "createdAt": "2026-03-30T15:30:51.464820Z",
    "updatedAt": "2026-03-30T15:34:51.445720Z",
    "defaultLanguage": "en",
    "defaultTimezone": "UTC",
    "defaultCountry": "US"
  }
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885052388,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

GET `/web/v1/system/profile/invitations`

Reads profile invitations.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885052402,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": []
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885052406,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/system/profile/invitations/accept`

Submits profile invitations accept.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{
  "invitationBizId": "non-existent-invitation-id"
}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885052411,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/profile/invitations/decline`

Submits profile invitations decline.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{
  "invitationBizId": "non-existent-invitation-id",
  "reason": "Documentation verification decline example"
}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885052423,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/profile/update`

Submits profile update.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{
  "accountName": "System Admin",
  "accountPhone": "+10000000000",
  "defaultLanguage": "en",
  "defaultTimezone": "UTC",
  "defaultCountry": "US"
}

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885052394,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "qiE8ybw1ol0WRhb3",
    "institutionBizId": "TvL208Vd9Q8Wh3wz",
    "accountEmail": "admin@slaunchx.test",
    "accountPhone": "+10000000000",
    "accountName": "System Admin",
    "accountRemark": null,
    "accountPortal": {
      "code": "SYSTEM",
      "value": 10010101,
      "label": "System Portal",
      "description": "System-level portal for platform administrators"
    },
    "accountStatus": {
      "code": "ACTIVE",
      "value": 10010202,
      "label": "Active",
      "description": "Account is active and usable"
    },
    "createdAt": "2026-03-30T15:30:51.464820Z",
    "updatedAt": "2026-03-30T15:37:32.392954290Z",
    "defaultLanguage": "en",
    "defaultTimezone": "UTC",
    "defaultCountry": "US"
  }
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885052397,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

Workspaces

GET `/web/v1/system/workspaces/current`

Reads workspaces current.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
X-Workspace-Id		Workspace ID (if present in request)

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885026805,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "HqqrE1zbJSlOJoIW",
    "institutionBizId": "TvL208Vd9Q8Wh3wz",
    "entityBizId": null,
    "workspaceName": "System Workspace",
    "workspaceTimezone": "UTC",
    "workspaceStatus": {
      "code": "ACTIVE",
      "value": 10010304,
      "label": "Active",
      "description": "Workspace is active and tenant verified"
    },
    "workspaceKind": {
      "code": "LIVE",
      "value": 10050101,
      "label": "Live",
      "description": "Primary workspace for production business operations"
    },
    "extraData": null,
    "createdAt": "2026-03-30T15:30:51.469503Z",
    "updatedAt": "2026-03-30T15:34:09.274573Z"
  }
}

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885026810,
  "success": false,
  "code": "GA2031",
  "message": "GA2031",
  "data": null
}

GET `/web/v1/system/workspaces/mine`

Reads workspaces mine.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885026794,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "userBizId": "qiE8ybw1ol0WRhb3",
      "workspaceBizId": "HqqrE1zbJSlOJoIW",
      "workspaceName": "System Workspace",
      "workspaceKind": {
        "code": "LIVE",
        "value": 10050101,
        "label": "Live",
        "description": "Primary workspace for production business operations"
      },
      "institutionBizId": "TvL208Vd9Q8Wh3wz",
      "workspaceRoleBizId": "IuxF8QLejWBcHK9a",
      "workspaceRoleName": "所有者",
      "joinSource": {
        "code": "REGISTRATION",
        "value": 10050201,
        "label": "Registration",
        "description": "Joined through self-registration"
      },
      "isOwner": true,
      "isDefault": true,
      "enterable": true,
      "defaultEligible": true,
      "policyConfig": null,
      "createdAt": "2026-03-30T15:30:51.469503Z",
      "updatedAt": "2026-03-30T15:34:09.283950Z"
    }
  ]
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885026799,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/system/workspaces`

Submits workspaces.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{
  "workspaceName": "",
  "workspaceTimezone": "UTC"
}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885026838,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/workspaces/admin/account-init-records/resend`

Submits workspaces admin account init records resend.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885026889,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/workspaces/admin/lookup`

Submits workspaces admin lookup.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{
  "targetWorkspaceBizId": "HqqrE1zbJSlOJoIW"
}

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885026857,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "HqqrE1zbJSlOJoIW",
    "institutionBizId": "TvL208Vd9Q8Wh3wz",
    "entityBizId": null,
    "workspaceName": "System Workspace",
    "workspaceTimezone": "UTC",
    "workspaceStatus": {
      "code": "ACTIVE",
      "value": 10010304,
      "label": "Active",
      "description": "Workspace is active and tenant verified"
    },
    "workspaceKind": {
      "code": "LIVE",
      "value": 10050101,
      "label": "Live",
      "description": "Primary workspace for production business operations"
    },
    "extraData": null,
    "createdAt": "2026-03-30T15:30:51.469503Z",
    "updatedAt": "2026-03-30T15:37:06.817522Z"
  }
}

Error Response: (HTTP 404)

json

{
  "version": "2.0.0",
  "timestamp": 1774885026863,
  "success": false,
  "code": "RESOURCE.NOT_FOUND",
  "message": "Resource not found",
  "data": null
}

POST `/web/v1/system/workspaces/admin/ownership/transfer`

Submits workspaces admin ownership transfer.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885026882,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/workspaces/admin/query`

Submits workspaces admin query.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{
  "institutionBizId": null,
  "workspaceStatus": null,
  "workspaceName": null,
  "page": 0,
  "size": 20
}

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885026849,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "workspaces": [
      {
        "bizId": "bTzedK3pE7KtfnkK",
        "institutionBizId": "pekOCmPDkN18jQXf",
        "entityBizId": null,
        "workspaceName": "Doc-Verify Consumer WS",
        "workspaceTimezone": "UTC",
        "workspaceStatus": {
          "code": "ACTIVE",
          "value": 10010304,
          "label": "Active",
          "description": "Workspace is active and tenant verified"
        },
        "workspaceKind": {
          "code": "LIVE",
          "value": 10050101,
          "label": "Live",
          "description": "Primary workspace for production business operations"
        },
        "extraData": null,
        "createdAt": "2026-03-30T15:33:09.504146Z",
        "updatedAt": "2026-03-30T15:34:13.436382Z"
      },
      {
        "bizId": "XN6e38nLOpxOWUT9",
        "institutionBizId": "pekOCmPDkN18jQXf",
        "entityBizId": null,
        "workspaceName": "Partner Test Workspace",
        "workspaceTimezone": "UTC",
        "workspaceStatus": {
          "code": "ACTIVE",
          "value": 10010304,
          "label": "Active",
          "description": "Workspace is active and tenant verified"
        },
        "workspaceKind": {
          "code": "LIVE",
          "value": 10050101,
          "label": "Live",
          "description": "Primary workspace for production business operations"
        },
        "extraData": null,
        "createdAt": "2026-03-30T15:33:09.321412Z",
        "updatedAt": "2026-03-30T15:34:18.014615Z"
      }
    ],
    "totalElements": 4,
    "totalPages": 1,
    "currentPage": 0,
    "pageSize": 20
  }
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885026852,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/system/workspaces/admin/status`

Submits workspaces admin status.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885026868,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/workspaces/admin/update`

Submits workspaces admin update.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{
  "targetWorkspaceBizId": ""
}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885026876,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/workspaces/current/default`

Submits workspaces current default.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

null

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885026828,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "userBizId": "qiE8ybw1ol0WRhb3",
    "workspaceBizId": "HqqrE1zbJSlOJoIW",
    "workspaceName": "System Workspace",
    "workspaceKind": {
      "code": "LIVE",
      "value": 10050101,
      "label": "Live",
      "description": "Primary workspace for production business operations"
    },
    "institutionBizId": "TvL208Vd9Q8Wh3wz",
    "workspaceRoleBizId": "IuxF8QLejWBcHK9a",
    "workspaceRoleName": "所有者",
    "joinSource": {
      "code": "REGISTRATION",
      "value": 10050201,
      "label": "Registration",
      "description": "Joined through self-registration"
    },
    "isOwner": true,
    "isDefault": true,
    "enterable": true,
    "defaultEligible": true,
    "policyConfig": null,
    "createdAt": "2026-03-30T15:30:51.469503Z",
    "updatedAt": "2026-03-30T15:37:06.827378553Z"
  }
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885026831,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/system/workspaces/current/update`

Submits workspaces current update.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{
  "workspaceName": "System Workspace",
  "workspaceTimezone": "UTC"
}

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885026818,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "HqqrE1zbJSlOJoIW",
    "institutionBizId": "TvL208Vd9Q8Wh3wz",
    "entityBizId": null,
    "workspaceName": "System Workspace",
    "workspaceTimezone": "UTC",
    "workspaceStatus": {
      "code": "ACTIVE",
      "value": 10010304,
      "label": "Active",
      "description": "Workspace is active and tenant verified"
    },
    "workspaceKind": {
      "code": "LIVE",
      "value": 10050101,
      "label": "Live",
      "description": "Primary workspace for production business operations"
    },
    "extraData": null,
    "createdAt": "2026-03-30T15:30:51.469503Z",
    "updatedAt": "2026-03-30T15:37:06.817521877Z"
  }
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885026822,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

Files

GET `/web/v1/system/files/non-existent-file-biz-id`

Reads files non existent file biz id.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 404)

json

{
  "version": "2.0.0",
  "timestamp": 1774885024874,
  "success": false,
  "code": "FILE.NOT_FOUND",
  "message": "File was not found",
  "data": null
}

GET `/web/v1/system/files/non-existent-file-biz-id/download`

Reads files non existent file biz id download.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 404)

json

{
  "version": "2.0.0",
  "timestamp": 1774885024894,
  "success": false,
  "code": "FILE.NOT_FOUND",
  "message": "File was not found",
  "data": null
}

GET `/web/v1/system/files/non-existent-file-biz-id/download-url`

Reads files non existent file biz id download url.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 404)

json

{
  "version": "2.0.0",
  "timestamp": 1774885024886,
  "success": false,
  "code": "FILE.NOT_FOUND",
  "message": "File was not found",
  "data": null
}

GET `/web/v1/system/files/some-file-biz-id`

Reads files some file biz id.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885024878,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

GET `/web/v1/system/files/some-file-biz-id/download`

Reads files some file biz id download.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885024898,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/system/files/delete`

Submits files delete.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885024905,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/files/query`

Submits files query.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{
  "institutionBizId": "pekOCmPDkN18jQXf"
}

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885024862,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "items": [],
    "pagination": {
      "totalPages": 0,
      "totalRecords": 0,
      "currentPage": 1,
      "pageSize": 0,
      "hasNext": false,
      "empty": true,
      "paginated": false
    }
  }
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885024866,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/system/files/upload`

Submits files upload.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

null

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885024855,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

Accounts

GET `/web/v1/system/accounts/admin/non-existent-user-biz-id`

Reads accounts admin non existent user biz id.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 404)

json

{
  "version": "2.0.0",
  "timestamp": 1774885050909,
  "success": false,
  "code": "RESOURCE.NOT_FOUND",
  "message": "Resource not found",
  "data": null
}

GET `/web/v1/system/accounts/admin/some-user-biz-id`

Reads accounts admin some user biz id.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885050913,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/system/accounts/admin/password/reset`

Submits accounts admin password reset.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885050942,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/accounts/admin/query`

Submits accounts admin query.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{
  "institutionBizId": null,
  "accountPortal": null,
  "accountStatus": null,
  "email": null,
  "name": null,
  "page": 0,
  "size": 20
}

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885050898,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "accounts": [
      {
        "bizId": "qiE8ybw1ol0WRhb3",
        "institutionBizId": "TvL208Vd9Q8Wh3wz",
        "accountEmail": "admin@slaunchx.test",
        "accountPhone": "+10000000000",
        "accountName": "System Admin",
        "accountRemark": null,
        "accountPortal": {
          "code": "SYSTEM",
          "value": 10010101,
          "label": "System Portal",
          "description": "System-level portal for platform administrators"
        },
        "accountStatus": {
          "code": "ACTIVE",
          "value": 10010202,
          "label": "Active",
          "description": "Account is active and usable"
        },
        "createdAt": "2026-03-30T15:30:51.464820Z",
        "updatedAt": "2026-03-30T15:34:51.445720Z",
        "defaultLanguage": "en",
        "defaultTimezone": "UTC",
        "defaultCountry": "US"
      }
    ],
    "totalElements": 1,
    "totalPages": 1,
    "currentPage": 0,
    "pageSize": 20
  }
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885050902,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/system/accounts/admin/status`

Submits accounts admin status.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885050931,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/accounts/admin/update`

Submits accounts admin update.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{
  "userBizId": ""
}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885050920,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

Constants

GET `/web/v1/system/constants/countries`

Reads constants countries.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054271,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "code": "CN",
      "value": 95010301,
      "label": "China",
      "alpha2Code": "CN",
      "alpha3Code": "CHN",
      "numericCode": 156,
      "phoneCode": "86"
    },
    {
      "code": "JP",
      "value": 95010302,
      "label": "Japan",
      "alpha2Code": "JP",
      "alpha3Code": "JPN",
      "numericCode": 392,
      "phoneCode": "81"
    }
  ]
}

Error Response: (HTTP 403)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054272,
  "success": false,
  "code": "ACCESS.PERMISSION_DENIED",
  "message": "Access denied",
  "data": null
}

GET `/web/v1/system/constants/currency-config-statuses`

Reads constants currency config statuses.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054358,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "code": "ENABLED",
      "value": 55010101,
      "label": "enum.CurrencyConfigStatus.ENABLED"
    },
    {
      "code": "DISABLED",
      "value": 55010102,
      "label": "enum.CurrencyConfigStatus.DISABLED"
    }
  ]
}

Error Response: (HTTP 403)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054359,
  "success": false,
  "code": "ACCESS.PERMISSION_DENIED",
  "message": "Access denied",
  "data": null
}

GET `/web/v1/system/constants/notification-channel-statuses`

Reads constants notification channel statuses.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054337,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "code": "ACTIVE",
      "value": 80010201,
      "label": "Active"
    },
    {
      "code": "INACTIVE",
      "value": 80010202,
      "label": "Inactive"
    }
  ]
}

Error Response: (HTTP 403)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054338,
  "success": false,
  "code": "ACCESS.PERMISSION_DENIED",
  "message": "Access denied",
  "data": null
}

GET `/web/v1/system/constants/notification-channel-type-statuses`

Reads constants notification channel type statuses.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054341,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "code": "ENABLED",
      "value": 80010301,
      "label": "Enabled"
    },
    {
      "code": "DISABLED",
      "value": 80010302,
      "label": "Disabled"
    }
  ]
}

Error Response: (HTTP 403)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054342,
  "success": false,
  "code": "ACCESS.PERMISSION_DENIED",
  "message": "Access denied",
  "data": null
}

GET `/web/v1/system/constants/notification-channel-types`

Reads constants notification channel types.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054333,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "code": "EMAIL",
      "value": 80010101,
      "label": "Email"
    }
  ]
}

Error Response: (HTTP 403)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054334,
  "success": false,
  "code": "ACCESS.PERMISSION_DENIED",
  "message": "Access denied",
  "data": null
}

GET `/web/v1/system/constants/order-statuses`

Reads constants order statuses.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054354,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "code": "PROCESSING",
      "value": 30010101,
      "label": "Processing"
    },
    {
      "code": "AUDITING",
      "value": 30010102,
      "label": "enum.OrderStatus.AUDITING"
    }
  ]
}

Error Response: (HTTP 403)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054355,
  "success": false,
  "code": "ACCESS.PERMISSION_DENIED",
  "message": "Access denied",
  "data": null
}

GET `/web/v1/system/constants/timezones`

Reads constants timezones.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054275,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "code": "UTC",
      "value": 95010101,
      "label": "Coordinated Universal Time",
      "zoneIdCode": "UTC",
      "utcOffset": "UTC+0"
    },
    {
      "code": "ASIA_SHANGHAI",
      "value": 95010102,
      "label": "China Standard Time",
      "zoneIdCode": "Asia/Shanghai",
      "utcOffset": "UTC+8"
    }
  ]
}

Error Response: (HTTP 403)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054276,
  "success": false,
  "code": "ACCESS.PERMISSION_DENIED",
  "message": "Access denied",
  "data": null
}

GET `/web/v1/system/constants/transfer-statuses`

Reads constants transfer statuses.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054350,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "code": "PENDING",
      "value": 35010701,
      "label": "Pending"
    },
    {
      "code": "PROCESSING",
      "value": 35010702,
      "label": "Processing"
    }
  ]
}

Error Response: (HTTP 403)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054351,
  "success": false,
  "code": "ACCESS.PERMISSION_DENIED",
  "message": "Access denied",
  "data": null
}

GET `/web/v1/system/constants/us-states`

Reads constants us states.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054280,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "code": "AL",
      "value": 95010401,
      "label": "enum.UsState.AL",
      "isoCode": "AL"
    },
    {
      "code": "AK",
      "value": 95010402,
      "label": "enum.UsState.AK",
      "isoCode": "AK"
    }
  ]
}

Error Response: (HTTP 403)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054281,
  "success": false,
  "code": "ACCESS.PERMISSION_DENIED",
  "message": "Access denied",
  "data": null
}

GET `/web/v1/system/constants/user-account-statuses`

Reads constants user account statuses.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054285,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "code": "REGISTERED",
      "value": 10010201,
      "label": "Registered"
    },
    {
      "code": "ACTIVE",
      "value": 10010202,
      "label": "Active"
    }
  ]
}

Error Response: (HTTP 403)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054286,
  "success": false,
  "code": "ACCESS.PERMISSION_DENIED",
  "message": "Access denied",
  "data": null
}

GET `/web/v1/system/constants/user-institution-statuses`

Reads constants user institution statuses.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054300,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "code": "PENDING",
      "value": 10010401,
      "label": "Pending Review"
    },
    {
      "code": "REVIEWING",
      "value": 10010402,
      "label": "Reviewing"
    }
  ]
}

Error Response: (HTTP 403)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054301,
  "success": false,
  "code": "ACCESS.PERMISSION_DENIED",
  "message": "Access denied",
  "data": null
}

GET `/web/v1/system/constants/user-institution-types`

Reads constants user institution types.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054296,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "code": "PLATFORM",
      "value": 10010601,
      "label": "Platform"
    },
    {
      "code": "TENANT",
      "value": 10010602,
      "label": "Tenant"
    }
  ]
}

Error Response: (HTTP 403)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054297,
  "success": false,
  "code": "ACCESS.PERMISSION_DENIED",
  "message": "Access denied",
  "data": null
}

GET `/web/v1/system/constants/user-invitation-statuses`

Reads constants user invitation statuses.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054320,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "code": "PENDING",
      "value": 10050301,
      "label": "Pending"
    },
    {
      "code": "ACCEPTED",
      "value": 10050302,
      "label": "Accepted"
    }
  ]
}

Error Response: (HTTP 403)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054321,
  "success": false,
  "code": "ACCESS.PERMISSION_DENIED",
  "message": "Access denied",
  "data": null
}

GET `/web/v1/system/constants/user-join-sources`

Reads constants user join sources.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054324,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "code": "REGISTRATION",
      "value": 10050201,
      "label": "Registration"
    },
    {
      "code": "INVITATION",
      "value": 10050202,
      "label": "Invitation"
    }
  ]
}

Error Response: (HTTP 403)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054325,
  "success": false,
  "code": "ACCESS.PERMISSION_DENIED",
  "message": "Access denied",
  "data": null
}

GET `/web/v1/system/constants/user-mfa-methods`

Reads constants user mfa methods.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054309,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "code": "EMAIL",
      "value": 10011001,
      "label": "Email"
    },
    {
      "code": "OTP",
      "value": 10011002,
      "label": "OTP"
    }
  ]
}

Error Response: (HTTP 403)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054310,
  "success": false,
  "code": "ACCESS.PERMISSION_DENIED",
  "message": "Access denied",
  "data": null
}

GET `/web/v1/system/constants/user-permission-statuses`

Reads constants user permission statuses.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054316,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "code": "ACTIVE",
      "value": 13010201,
      "label": "Active"
    },
    {
      "code": "DEPRECATED",
      "value": 13010202,
      "label": "Deprecated"
    }
  ]
}

Error Response: (HTTP 403)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054317,
  "success": false,
  "code": "ACCESS.PERMISSION_DENIED",
  "message": "Access denied",
  "data": null
}

GET `/web/v1/system/constants/user-permission-types`

Reads constants user permission types.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054313,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "code": "MENU",
      "value": 13010101,
      "label": "Menu"
    },
    {
      "code": "BUTTON",
      "value": 13010102,
      "label": "Button"
    }
  ]
}

Error Response: (HTTP 403)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054313,
  "success": false,
  "code": "ACCESS.PERMISSION_DENIED",
  "message": "Access denied",
  "data": null
}

GET `/web/v1/system/constants/user-portal-types`

Reads constants user portal types.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054291,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "code": "SYSTEM",
      "value": 10010101,
      "label": "System Portal"
    },
    {
      "code": "TENANT",
      "value": 10010102,
      "label": "Tenant Portal"
    }
  ]
}

Error Response: (HTTP 403)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054292,
  "success": false,
  "code": "ACCESS.PERMISSION_DENIED",
  "message": "Access denied",
  "data": null
}

GET `/web/v1/system/constants/user-workspace-statuses`

Reads constants user workspace statuses.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054305,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "code": "PENDING_TENANT",
      "value": 10010301,
      "label": "Pending Tenant Info"
    },
    {
      "code": "PENDING_REVIEW",
      "value": 10010302,
      "label": "Pending Review"
    }
  ]
}

Error Response: (HTTP 403)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054306,
  "success": false,
  "code": "ACCESS.PERMISSION_DENIED",
  "message": "Access denied",
  "data": null
}

GET `/web/v1/system/constants/wallet-statuses`

Reads constants wallet statuses.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054345,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "code": "ACTIVE",
      "value": 35010101,
      "label": "Active"
    },
    {
      "code": "INACTIVE",
      "value": 35010102,
      "label": "Inactive"
    }
  ]
}

Error Response: (HTTP 403)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054346,
  "success": false,
  "code": "ACCESS.PERMISSION_DENIED",
  "message": "Access denied",
  "data": null
}

GET `/web/v1/system/constants/workspace-role-types`

Reads constants workspace role types.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054329,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "code": "OWNER",
      "value": 10010901,
      "label": "Owner"
    },
    {
      "code": "CUSTOM",
      "value": 10010902,
      "label": "Custom"
    }
  ]
}

Error Response: (HTTP 403)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054329,
  "success": false,
  "code": "ACCESS.PERMISSION_DENIED",
  "message": "Access denied",
  "data": null
}

Currency Grants

GET `/web/v1/system/currency-grants`

Reads currency grants.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885025090,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": []
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885025093,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/system/currency-grants`

Submits currency grants.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885025104,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/currency-grants/revoke`

Submits currency grants revoke.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885025135,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

Institutions

GET `/web/v1/system/institutions/ci1Ut8AV1vjmU1HS`

Reads institutions ci1Ut8AV1vjmU1HS.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774871157027,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "ci1Ut8AV1vjmU1HS",
    "institutionName": "Doc-Verify Tenant",
    "institutionDescription": null,
    "institutionRemark": null,
    "institutionType": {
      "code": "TENANT",
      "value": 10010102,
      "label": "Tenant Portal",
      "description": "Tenant portal for business customers"
    },
    "institutionStatus": {
      "code": "ACTIVE",
      "value": 10010403,
      "label": "Active",
      "description": "Portal is active and verified"
    },
    "extraConfig": null,
    "createdAt": "2026-03-30T11:44:47.289112Z",
    "updatedAt": "2026-03-30T11:44:47.289112Z"
  }
}

GET `/web/v1/system/institutions/non-existent-biz-id`

Reads institutions non existent biz id.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 404)

json

{
  "version": "2.0.0",
  "timestamp": 1774885034847,
  "success": false,
  "code": "RESOURCE.NOT_FOUND",
  "message": "Resource not found",
  "data": null
}

GET `/web/v1/system/institutions/pekOCmPDkN18jQXf`

Reads institutions pekOCmPDkN18jQXf.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885034841,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "pekOCmPDkN18jQXf",
    "institutionName": "Doc-Verify Tenant",
    "institutionDescription": null,
    "institutionRemark": null,
    "institutionType": {
      "code": "TENANT",
      "value": 10010102,
      "label": "Tenant Portal",
      "description": "Tenant portal for business customers"
    },
    "institutionStatus": {
      "code": "ACTIVE",
      "value": 10010403,
      "label": "Active",
      "description": "Portal is active and verified"
    },
    "extraConfig": null,
    "createdAt": "2026-03-30T15:33:08.312561Z",
    "updatedAt": "2026-03-30T15:33:08.312561Z"
  }
}

GET `/web/v1/system/institutions/portals`

Reads institutions portals.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033878,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "id": 4,
      "institutionBizId": "pekOCmPDkN18jQXf",
      "portalType": 10010104,
      "domain": "doc-verify-consumer.local",
      "portalStatus": 10080101,
      "remark": null,
      "createdAt": "2026-03-30T15:33:08.375746Z",
      "updatedAt": "2026-03-30T15:33:08.375746Z"
    },
    {
      "id": 3,
      "institutionBizId": "pekOCmPDkN18jQXf",
      "portalType": 10010103,
      "domain": "doc-verify-partner.local",
      "portalStatus": 10080101,
      "remark": null,
      "createdAt": "2026-03-30T15:33:08.354469Z",
      "updatedAt": "2026-03-30T15:33:08.354469Z"
    }
  ]
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033881,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

GET `/web/v1/system/institutions/portals/portal-types/10010101/access-code`

Reads institutions portals portal types 10010101 access code.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 404)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033918,
  "success": false,
  "code": "RESOURCE.NOT_FOUND",
  "message": "Resource not found",
  "data": null
}

GET `/web/v1/system/institutions/portals/turnstile`

Reads institutions portals turnstile.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Success Response: (HTTP 404)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033944,
  "success": false,
  "code": "RESOURCE.NOT_FOUND",
  "message": "Resource not found",
  "data": null
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033948,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

GET `/web/v1/system/institutions/ROLxyZGtSwHSR2Dt`

Reads institutions ROLxyZGtSwHSR2Dt.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774882130731,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "ROLxyZGtSwHSR2Dt",
    "institutionName": "Doc-Verify Tenant",
    "institutionDescription": null,
    "institutionRemark": null,
    "institutionType": {
      "code": "TENANT",
      "value": 10010102,
      "label": "Tenant Portal",
      "description": "Tenant portal for business customers"
    },
    "institutionStatus": {
      "code": "ACTIVE",
      "value": 10010403,
      "label": "Active",
      "description": "Portal is active and verified"
    },
    "extraConfig": null,
    "createdAt": "2026-03-30T11:59:58.885898Z",
    "updatedAt": "2026-03-30T11:59:58.885898Z"
  }
}

GET `/web/v1/system/institutions/self`

Reads institutions self.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885034887,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "TvL208Vd9Q8Wh3wz",
    "institutionName": "SlaunchX DOC-VERIFY",
    "institutionDescription": null,
    "institutionRemark": null,
    "institutionType": {
      "code": "SYSTEM",
      "value": 10010101,
      "label": "System Portal",
      "description": "System-level portal for platform administrators"
    },
    "institutionStatus": {
      "code": "ACTIVE",
      "value": 10010403,
      "label": "Active",
      "description": "Portal is active and verified"
    },
    "extraConfig": null,
    "createdAt": "2026-03-30T15:30:50.661210Z",
    "updatedAt": "2026-03-30T15:30:50.661210Z"
  }
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885034890,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/system/institutions`

Submits institutions.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885034867,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/institutions/admin-init`

Submits institutions admin init.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{
  "institutionBizId": "non-existent-institution-id",
  "email": "admin-init-test@example.com",
  "name": "Test Admin",
  "phone": "+10000000001"
}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 404)

json

{
  "version": "2.0.0",
  "timestamp": 1774885034873,
  "success": false,
  "code": "INSTITUTION.NOT_FOUND",
  "message": "Institution was not found",
  "data": null
}

POST `/web/v1/system/institutions/portals`

Submits institutions portals.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033886,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/institutions/portals/access-code/generate`

Submits institutions portals access code generate.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033908,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/institutions/portals/access-code/revoke`

Submits institutions portals access code revoke.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033937,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/institutions/portals/access-code/rotate`

Submits institutions portals access code rotate.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033930,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/institutions/portals/revoke`

Submits institutions portals revoke.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033902,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/institutions/portals/turnstile/disable`

Submits institutions portals turnstile disable.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033966,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/institutions/portals/turnstile/enable`

Submits institutions portals turnstile enable.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033960,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/institutions/portals/turnstile/update`

Submits institutions portals turnstile update.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033954,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/institutions/portals/update`

Submits institutions portals update.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885033896,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/institutions/query`

Submits institutions query.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{
  "institutionBizId": null,
  "institutionType": null,
  "institutionStatus": null,
  "institutionName": null,
  "page": 0,
  "size": 20
}

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885034833,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "institutions": [
      {
        "bizId": "pekOCmPDkN18jQXf",
        "institutionName": "Doc-Verify Tenant",
        "institutionDescription": null,
        "institutionRemark": null,
        "institutionType": {
          "code": "TENANT",
          "value": 10010102,
          "label": "Tenant Portal",
          "description": "Tenant portal for business customers"
        },
        "institutionStatus": {
          "code": "ACTIVE",
          "value": 10010403,
          "label": "Active",
          "description": "Portal is active and verified"
        },
        "extraConfig": null,
        "createdAt": "2026-03-30T15:33:08.312561Z",
        "updatedAt": "2026-03-30T15:33:08.312561Z"
      },
      {
        "bizId": "TvL208Vd9Q8Wh3wz",
        "institutionName": "SlaunchX DOC-VERIFY",
        "institutionDescription": null,
        "institutionRemark": null,
        "institutionType": {
          "code": "SYSTEM",
          "value": 10010101,
          "label": "System Portal",
          "description": "System-level portal for platform administrators"
        },
        "institutionStatus": {
          "code": "ACTIVE",
          "value": 10010403,
          "label": "Active",
          "description": "Portal is active and verified"
        },
        "extraConfig": null,
        "createdAt": "2026-03-30T15:30:50.661210Z",
        "updatedAt": "2026-03-30T15:30:50.661210Z"
      }
    ],
    "totalElements": 2,
    "totalPages": 1,
    "currentPage": 0,
    "pageSize": 20
  }
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885034836,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/system/institutions/self/update`

Submits institutions self update.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{
  "institutionBizId": "pekOCmPDkN18jQXf",
  "institutionName": "Updated Self Institution"
}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885034894,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/system/institutions/status`

Submits institutions status.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885034858,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/institutions/update`

Submits institutions update.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{
  "institutionBizId": "",
  "institutionName": "Updated Name"
}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885034853,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

Invitations

GET `/web/v1/system/invitations`

Reads invitations.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885051548,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": []
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885051556,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/system/invitations`

Submits invitations.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{
  "inviteeEmail": "not-a-valid-email",
  "message": "Test invitation",
  "expirationDays": 7
}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885051562,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/invitations/cancel`

Submits invitations cancel.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{
  "invitationBizId": "non-existent-invitation-id",
  "reason": "Documentation verification cancel example"
}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885051579,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

Notifications

POST `/web/v1/system/notifications/channel-types/create`

Submits notifications channel types create.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885027792,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/notifications/channel-types/delete`

Submits notifications channel types delete.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885027817,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/notifications/channel-types/disable`

Submits notifications channel types disable.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885027811,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/notifications/channel-types/enable`

Submits notifications channel types enable.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885027805,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/notifications/channel-types/query`

Submits notifications channel types query.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{
  "bizId": null,
  "typeCode": null,
  "typeStatus": null,
  "enabledOnly": false
}

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885027782,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "items": [
      {
        "bizId": "Ia5gNk9xkU1wgRXs",
        "typeCode": "EMAIL",
        "typeValue": 80010101,
        "typeName": "Email",
        "typeDescription": "SMTP-based email notification channel",
        "typeStatus": {
          "code": "ENABLED",
          "value": 80010301,
          "label": "Enabled",
          "description": "Channel type enabled"
        },
        "displayOrder": 0,
        "iconUrl": null,
        "extraConfig": null,
        "createdAt": "2026-03-30T15:30:50.675053Z",
        "updatedAt": "2026-03-30T15:30:50.675053Z",
        "enabled": true
      }
    ],
    "pagination": {
      "totalPages": 1,
      "totalRecords": 1,
      "currentPage": 1,
      "pageSize": 1,
      "hasNext": false,
      "empty": false,
      "paginated": false
    }
  }
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885027786,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/system/notifications/channel-types/update`

Submits notifications channel types update.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885027798,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/notifications/channels/activate`

Submits notifications channels activate.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885027858,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/notifications/channels/create`

Submits notifications channels create.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885027841,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/notifications/channels/deactivate`

Submits notifications channels deactivate.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885027865,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/notifications/channels/delete`

Submits notifications channels delete.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885027884,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/notifications/channels/query`

Submits notifications channels query.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{
  "bizId": null,
  "institutionBizId": null,
  "channelCategory": null,
  "channelStatus": null,
  "activeOnly": false
}

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885027831,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "items": [],
    "pagination": {
      "totalPages": 0,
      "totalRecords": 0,
      "currentPage": 1,
      "pageSize": 0,
      "hasNext": false,
      "empty": true,
      "paginated": false
    }
  }
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885027835,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/system/notifications/channels/update`

Submits notifications channels update.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885027851,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/notifications/email/validate/imap`

Submits notifications email validate imap.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885027776,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/notifications/email/validate/smtp`

Submits notifications email validate smtp.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885027767,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

Roles

GET `/web/v1/system/roles`

Reads roles.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885028078,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "bizId": "IuxF8QLejWBcHK9a",
      "workspaceBizId": "HqqrE1zbJSlOJoIW",
      "roleName": "所有者",
      "roleType": {
        "code": "OWNER",
        "value": 10010901,
        "label": "Owner",
        "description": "Built-in owner role"
      },
      "description": "空间所有者，拥有全部权限",
      "permissionCodes": [],
      "createdAt": "2026-03-30T15:30:51.473692Z",
      "updatedAt": "2026-03-30T15:30:51.473692Z"
    },
    {
      "bizId": "5aH5TdSI4ok5tuR7",
      "workspaceBizId": "HqqrE1zbJSlOJoIW",
      "roleName": "成员",
      "roleType": {
        "code": "CUSTOM",
        "value": 10010902,
        "label": "Custom",
        "description": "Custom defined role"
      },
      "description": "默认成员角色",
      "permissionCodes": [],
      "createdAt": "2026-03-30T15:30:51.474728Z",
      "updatedAt": "2026-03-30T15:30:51.474728Z"
    }
  ]
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885028081,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

GET `/web/v1/system/roles/2Zc6blL91b7dalbm`

Reads roles 2Zc6blL91b7dalbm.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774871113791,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "2Zc6blL91b7dalbm",
    "workspaceBizId": "vXIErM261gKsxa9R",
    "roleName": "DocVerify Test Role 1774871113773",
    "roleType": {
      "code": "CUSTOM",
      "value": 10010902,
      "label": "Custom",
      "description": "Custom defined role"
    },
    "description": "Temporary role created by doc-verify test suite",
    "permissionCodes": [],
    "createdAt": "2026-03-30T11:45:13.779480Z",
    "updatedAt": "2026-03-30T11:45:13.779480Z"
  }
}

GET `/web/v1/system/roles/2Zc6blL91b7dalbm/permissions`

Reads roles 2Zc6blL91b7dalbm permissions.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774871113810,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": []
}

GET `/web/v1/system/roles/5Si2dFPTaJ6ibxLZ`

Reads roles 5Si2dFPTaJ6ibxLZ.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774884810570,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "5Si2dFPTaJ6ibxLZ",
    "workspaceBizId": "HqqrE1zbJSlOJoIW",
    "roleName": "DocVerify Test Role 1774884810547",
    "roleType": {
      "code": "CUSTOM",
      "value": 10010902,
      "label": "Custom",
      "description": "Custom defined role"
    },
    "description": "Temporary role created by doc-verify test suite",
    "permissionCodes": [],
    "createdAt": "2026-03-30T15:33:30.555325Z",
    "updatedAt": "2026-03-30T15:33:30.555325Z"
  }
}

GET `/web/v1/system/roles/5Si2dFPTaJ6ibxLZ/permissions`

Reads roles 5Si2dFPTaJ6ibxLZ permissions.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774884810591,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": []
}

GET `/web/v1/system/roles/6rvnEEOFrnJzZnzD`

Reads roles 6rvnEEOFrnJzZnzD.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774879283772,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "6rvnEEOFrnJzZnzD",
    "workspaceBizId": "MBuz6sM9ClvjHEjf",
    "roleName": "DocVerify Test Role 1774879283754",
    "roleType": {
      "code": "CUSTOM",
      "value": 10010902,
      "label": "Custom",
      "description": "Custom defined role"
    },
    "description": "Temporary role created by doc-verify test suite",
    "permissionCodes": [],
    "createdAt": "2026-03-30T14:01:23.760493Z",
    "updatedAt": "2026-03-30T14:01:23.760493Z"
  }
}

GET `/web/v1/system/roles/6rvnEEOFrnJzZnzD/permissions`

Reads roles 6rvnEEOFrnJzZnzD permissions.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774879283791,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": []
}

GET `/web/v1/system/roles/EbkkZ6OoFZcwJ50u`

Reads roles EbkkZ6OoFZcwJ50u.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774872145723,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "EbkkZ6OoFZcwJ50u",
    "workspaceBizId": "MBuz6sM9ClvjHEjf",
    "roleName": "DocVerify Test Role 1774872145705",
    "roleType": {
      "code": "CUSTOM",
      "value": 10010902,
      "label": "Custom",
      "description": "Custom defined role"
    },
    "description": "Temporary role created by doc-verify test suite",
    "permissionCodes": [],
    "createdAt": "2026-03-30T12:02:25.711381Z",
    "updatedAt": "2026-03-30T12:02:25.711381Z"
  }
}

GET `/web/v1/system/roles/EbkkZ6OoFZcwJ50u/permissions`

Reads roles EbkkZ6OoFZcwJ50u permissions.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774872145742,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": []
}

GET `/web/v1/system/roles/hGgXChetbLOhZnd2`

Reads roles hGgXChetbLOhZnd2.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774882129753,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "hGgXChetbLOhZnd2",
    "workspaceBizId": "MBuz6sM9ClvjHEjf",
    "roleName": "DocVerify Test Role 1774882129731",
    "roleType": {
      "code": "CUSTOM",
      "value": 10010902,
      "label": "Custom",
      "description": "Custom defined role"
    },
    "description": "Temporary role created by doc-verify test suite",
    "permissionCodes": [],
    "createdAt": "2026-03-30T14:48:49.738712Z",
    "updatedAt": "2026-03-30T14:48:49.738712Z"
  }
}

GET `/web/v1/system/roles/hGgXChetbLOhZnd2/permissions`

Reads roles hGgXChetbLOhZnd2 permissions.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774882129780,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": []
}

GET `/web/v1/system/roles/hqVKSVxuQVu5XN9O`

Reads roles hqVKSVxuQVu5XN9O.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774872030969,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "hqVKSVxuQVu5XN9O",
    "workspaceBizId": "MBuz6sM9ClvjHEjf",
    "roleName": "DocVerify Test Role 1774872030946",
    "roleType": {
      "code": "CUSTOM",
      "value": 10010902,
      "label": "Custom",
      "description": "Custom defined role"
    },
    "description": "Temporary role created by doc-verify test suite",
    "permissionCodes": [],
    "createdAt": "2026-03-30T12:00:30.954618Z",
    "updatedAt": "2026-03-30T12:00:30.954618Z"
  }
}

GET `/web/v1/system/roles/hqVKSVxuQVu5XN9O/permissions`

Reads roles hqVKSVxuQVu5XN9O permissions.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774872030990,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": []
}

GET `/web/v1/system/roles/K2LSDyemPYklA8Pi`

Reads roles K2LSDyemPYklA8Pi.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774880815213,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "K2LSDyemPYklA8Pi",
    "workspaceBizId": "MBuz6sM9ClvjHEjf",
    "roleName": "DocVerify Test Role 1774880815195",
    "roleType": {
      "code": "CUSTOM",
      "value": 10010902,
      "label": "Custom",
      "description": "Custom defined role"
    },
    "description": "Temporary role created by doc-verify test suite",
    "permissionCodes": [],
    "createdAt": "2026-03-30T14:26:55.200278Z",
    "updatedAt": "2026-03-30T14:26:55.200278Z"
  }
}

GET `/web/v1/system/roles/K2LSDyemPYklA8Pi/permissions`

Reads roles K2LSDyemPYklA8Pi permissions.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774880815232,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": []
}

GET `/web/v1/system/roles/MLUtRKO7r8Y9ej08`

Reads roles MLUtRKO7r8Y9ej08.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774879245743,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "MLUtRKO7r8Y9ej08",
    "workspaceBizId": "MBuz6sM9ClvjHEjf",
    "roleName": "DocVerify Test Role 1774879245724",
    "roleType": {
      "code": "CUSTOM",
      "value": 10010902,
      "label": "Custom",
      "description": "Custom defined role"
    },
    "description": "Temporary role created by doc-verify test suite",
    "permissionCodes": [],
    "createdAt": "2026-03-30T14:00:45.730640Z",
    "updatedAt": "2026-03-30T14:00:45.730640Z"
  }
}

GET `/web/v1/system/roles/MLUtRKO7r8Y9ej08/permissions`

Reads roles MLUtRKO7r8Y9ej08 permissions.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774879245762,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": []
}

GET `/web/v1/system/roles/Mnsy0bdiv4yWoxEu`

Reads roles Mnsy0bdiv4yWoxEu.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774872069835,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "Mnsy0bdiv4yWoxEu",
    "workspaceBizId": "MBuz6sM9ClvjHEjf",
    "roleName": "DocVerify Test Role 1774872069817",
    "roleType": {
      "code": "CUSTOM",
      "value": 10010902,
      "label": "Custom",
      "description": "Custom defined role"
    },
    "description": "Temporary role created by doc-verify test suite",
    "permissionCodes": [],
    "createdAt": "2026-03-30T12:01:09.823119Z",
    "updatedAt": "2026-03-30T12:01:09.823119Z"
  }
}

GET `/web/v1/system/roles/Mnsy0bdiv4yWoxEu/permissions`

Reads roles Mnsy0bdiv4yWoxEu permissions.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774872069854,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": []
}

GET `/web/v1/system/roles/non-existent-role-id`

Reads roles non existent role id.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 404)

json

{
  "version": "2.0.0",
  "timestamp": 1774885028107,
  "success": false,
  "code": "RESOURCE.NOT_FOUND",
  "message": "Resource not found",
  "data": null
}

GET `/web/v1/system/roles/non-existent-role-id/permissions`

Reads roles non existent role id permissions.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 404)

json

{
  "version": "2.0.0",
  "timestamp": 1774885028127,
  "success": false,
  "code": "RESOURCE.NOT_FOUND",
  "message": "Resource not found",
  "data": null
}

GET `/web/v1/system/roles/O2AdNAWfVwFhkl4O`

Reads roles O2AdNAWfVwFhkl4O.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774884851713,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "O2AdNAWfVwFhkl4O",
    "workspaceBizId": "HqqrE1zbJSlOJoIW",
    "roleName": "DocVerify Test Role 1774884851695",
    "roleType": {
      "code": "CUSTOM",
      "value": 10010902,
      "label": "Custom",
      "description": "Custom defined role"
    },
    "description": "Temporary role created by doc-verify test suite",
    "permissionCodes": [],
    "createdAt": "2026-03-30T15:34:11.701665Z",
    "updatedAt": "2026-03-30T15:34:11.701665Z"
  }
}

GET `/web/v1/system/roles/O2AdNAWfVwFhkl4O/permissions`

Reads roles O2AdNAWfVwFhkl4O permissions.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774884851730,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": []
}

GET `/web/v1/system/roles/permissions/tree`

Reads roles permissions tree.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885028069,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "bizId": "e4ce5d66-df92-4d14-864d-c4f9e8250c50",
      "permissionCode": "currency-grant:read",
      "permissionName": "Currency Grant Read",
      "permissionDescription": null,
      "parentBizId": null,
      "permissionGroup": "currency-grant",
      "portalVisibility": null,
      "sortOrder": 3,
      "isEnabled": true,
      "children": []
    },
    {
      "bizId": "c905f9db-a8bf-4be7-bfef-4f52a96e34f4",
      "permissionCode": "currency-grant:write",
      "permissionName": "Currency Grant Write",
      "permissionDescription": null,
      "parentBizId": null,
      "permissionGroup": "currency-grant",
      "portalVisibility": null,
      "sortOrder": 4,
      "isEnabled": true,
      "children": []
    }
  ]
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885028073,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

GET `/web/v1/system/roles/qcp9joomLN7irGtC`

Reads roles qcp9joomLN7irGtC.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774881525595,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "qcp9joomLN7irGtC",
    "workspaceBizId": "MBuz6sM9ClvjHEjf",
    "roleName": "DocVerify Test Role 1774881525577",
    "roleType": {
      "code": "CUSTOM",
      "value": 10010902,
      "label": "Custom",
      "description": "Custom defined role"
    },
    "description": "Temporary role created by doc-verify test suite",
    "permissionCodes": [],
    "createdAt": "2026-03-30T14:38:45.583156Z",
    "updatedAt": "2026-03-30T14:38:45.583156Z"
  }
}

GET `/web/v1/system/roles/qcp9joomLN7irGtC/permissions`

Reads roles qcp9joomLN7irGtC permissions.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774881525615,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": []
}

GET `/web/v1/system/roles/sUNYomXK6uRmEidb`

Reads roles sUNYomXK6uRmEidb.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774871157817,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "sUNYomXK6uRmEidb",
    "workspaceBizId": "vXIErM261gKsxa9R",
    "roleName": "DocVerify Test Role 1774871157793",
    "roleType": {
      "code": "CUSTOM",
      "value": 10010902,
      "label": "Custom",
      "description": "Custom defined role"
    },
    "description": "Temporary role created by doc-verify test suite",
    "permissionCodes": [],
    "createdAt": "2026-03-30T11:45:57.801034Z",
    "updatedAt": "2026-03-30T11:45:57.801034Z"
  }
}

GET `/web/v1/system/roles/sUNYomXK6uRmEidb/permissions`

Reads roles sUNYomXK6uRmEidb permissions.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774871157839,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": []
}

GET `/web/v1/system/roles/uU6x5D1YIFwx9yZx`

Reads roles uU6x5D1YIFwx9yZx.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885028101,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "uU6x5D1YIFwx9yZx",
    "workspaceBizId": "HqqrE1zbJSlOJoIW",
    "roleName": "DocVerify Test Role 1774885028082",
    "roleType": {
      "code": "CUSTOM",
      "value": 10010902,
      "label": "Custom",
      "description": "Custom defined role"
    },
    "description": "Temporary role created by doc-verify test suite",
    "permissionCodes": [],
    "createdAt": "2026-03-30T15:37:08.088753Z",
    "updatedAt": "2026-03-30T15:37:08.088753Z"
  }
}

GET `/web/v1/system/roles/uU6x5D1YIFwx9yZx/permissions`

Reads roles uU6x5D1YIFwx9yZx permissions.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885028120,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": []
}

GET `/web/v1/system/roles/ZwU6MbMtu56UQdkt`

Reads roles ZwU6MbMtu56UQdkt.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774879404580,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "ZwU6MbMtu56UQdkt",
    "workspaceBizId": "MBuz6sM9ClvjHEjf",
    "roleName": "DocVerify Test Role 1774879404559",
    "roleType": {
      "code": "CUSTOM",
      "value": 10010902,
      "label": "Custom",
      "description": "Custom defined role"
    },
    "description": "Temporary role created by doc-verify test suite",
    "permissionCodes": [],
    "createdAt": "2026-03-30T14:03:24.564557Z",
    "updatedAt": "2026-03-30T14:03:24.564557Z"
  }
}

GET `/web/v1/system/roles/ZwU6MbMtu56UQdkt/permissions`

Reads roles ZwU6MbMtu56UQdkt permissions.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774879404602,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": []
}

POST `/web/v1/system/roles`

Submits roles.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{
  "roleName": "DocVerify Test Role 1774885028082",
  "description": "Temporary role created by doc-verify test suite"
}

Success Response: (HTTP 201)

json

{
  "version": "2.0.0",
  "timestamp": 1774885028089,
  "success": true,
  "code": "2001",
  "message": "Created",
  "data": {
    "bizId": "uU6x5D1YIFwx9yZx",
    "workspaceBizId": "HqqrE1zbJSlOJoIW",
    "roleName": "DocVerify Test Role 1774885028082",
    "roleType": {
      "code": "CUSTOM",
      "value": 10010902,
      "label": "Custom",
      "description": "Custom defined role"
    },
    "description": "Temporary role created by doc-verify test suite",
    "permissionCodes": [],
    "createdAt": "2026-03-30T15:37:08.088752856Z",
    "updatedAt": "2026-03-30T15:37:08.088752856Z"
  }
}

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885028095,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/roles/delete`

Submits roles delete.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{
  "roleId": "uU6x5D1YIFwx9yZx"
}

Success Response: (HTTP 204)

json

null

Error Response: (HTTP 404)

json

{
  "version": "2.0.0",
  "timestamp": 1774885028153,
  "success": false,
  "code": "RESOURCE.NOT_FOUND",
  "message": "Resource not found",
  "data": null
}

POST `/web/v1/system/roles/members/role/change`

Submits roles members role change.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885028139,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/roles/permissions`

Submits roles permissions.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{
  "roleId": "",
  "permissionCodes": []
}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885028133,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/roles/update`

Submits roles update.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{
  "roleId": "",
  "roleName": "Updated Role Name"
}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885028113,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

Secure Channel

GET `/web/v1/system/secure-channel/public-key`

Reads secure channel public key.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885051964,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "keyId": "98611c863210",
    "publicKey": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA4Gw/YT1yLl3bVayyZ9Ax8Urc3Yt5eg6teQWdq82PyEgbtCPttdzrHHUw8FLsg4DNieg45wgrvwZByfiXI2r/hPiN8n0OlJkSEcUQbXXojq6/z8VH9Rq8vwRmIIrwQEa18LOCF+RdSjAGgSZSNthvS79KdwHGr9rXQkDncyXr3Idz7Md8Wk/U3qv2dsUM/G9/5pVR4liEwcmHfVGxh4wn1Biii4xkIZsltc4MFkOJy8QGhYwmw1j6jhlxEZbWsD7+TgI44WxjF+GY/k2LdHuOdyIpQdPb7U6AS84qUmChKpOzL006rDYwvhjxn0bANyNTniBlEg10g/wIdMe2VM9JMQIDAQAB",
    "algorithm": "RSA-OAEP-2048",
    "keySize": 2048,
    "createdAt": "2026-03-30T15:37:16.595562655Z",
    "expiresAt": null
  }
}

Error Response: (HTTP 403)

json

{
  "version": "2.0.0",
  "timestamp": 1774885051966,
  "success": false,
  "code": "ACCESS.PERMISSION_DENIED",
  "message": "Access denied",
  "data": null
}

POST `/web/v1/system/secure-channel/session`

Submits secure channel session.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885051988,
  "success": false,
  "code": "SECURE_CHANNEL.INVALID_PAYLOAD",
  "message": "Invalid payload format",
  "data": null
}

POST `/web/v1/system/secure-channel/session/close`

Submits secure channel session close.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

null

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 500)

json

{
  "version": "2.0.0",
  "timestamp": 1774885051997,
  "success": false,
  "code": "SYSTEM.INTERNAL_ERROR",
  "message": "Internal server error",
  "data": null
}

Slash

GET `/web/v1/system/slash/connections`

Reads slash connections.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885048900,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": []
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885048903,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

GET `/web/v1/system/slash/connections/non-existent-cid/accounts/non-existent-aid`

Reads slash connections non existent cid accounts non existent aid.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 500)

json

{
  "version": "2.0.0",
  "timestamp": 1774885048954,
  "success": false,
  "code": "SYSTEM.INTERNAL_ERROR",
  "message": "Internal server error",
  "data": null
}

GET `/web/v1/system/slash/connections/non-existent-cid/accounts/non-existent-aid/balances`

Reads slash connections non existent cid accounts non existent aid balances.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 500)

json

{
  "version": "2.0.0",
  "timestamp": 1774885048961,
  "success": false,
  "code": "SYSTEM.INTERNAL_ERROR",
  "message": "Internal server error",
  "data": null
}

GET `/web/v1/system/slash/connections/non-existent-cid/balances/top-level`

Reads slash connections non existent cid balances top level.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 500)

json

{
  "version": "2.0.0",
  "timestamp": 1774885048967,
  "success": false,
  "code": "SYSTEM.INTERNAL_ERROR",
  "message": "Internal server error",
  "data": null
}

GET `/web/v1/system/slash/connections/non-existent-cid/cards`

Reads slash connections non existent cid cards.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 500)

json

{
  "version": "2.0.0",
  "timestamp": 1774885048987,
  "success": false,
  "code": "SYSTEM.INTERNAL_ERROR",
  "message": "Internal server error",
  "data": null
}

GET `/web/v1/system/slash/connections/non-existent-cid/cards/non-existent-card-id`

Reads slash connections non existent cid cards non existent card id.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 500)

json

{
  "version": "2.0.0",
  "timestamp": 1774885048993,
  "success": false,
  "code": "SYSTEM.INTERNAL_ERROR",
  "message": "Internal server error",
  "data": null
}

GET `/web/v1/system/slash/connections/non-existent-cid/payments/handles`

Reads slash connections non existent cid payments handles.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 500)

json

{
  "version": "2.0.0",
  "timestamp": 1774885049017,
  "success": false,
  "code": "SYSTEM.INTERNAL_ERROR",
  "message": "Internal server error",
  "data": null
}

GET `/web/v1/system/slash/connections/non-existent-cid/transactions`

Reads slash connections non existent cid transactions.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 500)

json

{
  "version": "2.0.0",
  "timestamp": 1774885049023,
  "success": false,
  "code": "SYSTEM.INTERNAL_ERROR",
  "message": "Internal server error",
  "data": null
}

GET `/web/v1/system/slash/connections/non-existent-cid/transactions/aggregation`

Reads slash connections non existent cid transactions aggregation.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 500)

json

{
  "version": "2.0.0",
  "timestamp": 1774885049046,
  "success": false,
  "code": "SYSTEM.INTERNAL_ERROR",
  "message": "Internal server error",
  "data": null
}

GET `/web/v1/system/slash/connections/non-existent-cid/transactions/non-existent-tid`

Reads slash connections non existent cid transactions non existent tid.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 500)

json

{
  "version": "2.0.0",
  "timestamp": 1774885049030,
  "success": false,
  "code": "SYSTEM.INTERNAL_ERROR",
  "message": "Internal server error",
  "data": null
}

GET `/web/v1/system/slash/connections/non-existent-cid/transactions/non-existent-tid/fee-details`

Reads slash connections non existent cid transactions non existent tid fee details.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 500)

json

{
  "version": "2.0.0",
  "timestamp": 1774885049036,
  "success": false,
  "code": "SYSTEM.INTERNAL_ERROR",
  "message": "Internal server error",
  "data": null
}

GET `/web/v1/system/slash/connections/non-existent-cid/virtual-accounts`

Reads slash connections non existent cid virtual accounts.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 500)

json

{
  "version": "2.0.0",
  "timestamp": 1774885048974,
  "success": false,
  "code": "SYSTEM.INTERNAL_ERROR",
  "message": "Internal server error",
  "data": null
}

GET `/web/v1/system/slash/connections/non-existent-cid/virtual-accounts/non-existent-vid`

Reads slash connections non existent cid virtual accounts non existent vid.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 500)

json

{
  "version": "2.0.0",
  "timestamp": 1774885048980,
  "success": false,
  "code": "SYSTEM.INTERNAL_ERROR",
  "message": "Internal server error",
  "data": null
}

GET `/web/v1/system/slash/connections/non-existent-connection-id`

Reads slash connections non existent connection id.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 500)

json

{
  "version": "2.0.0",
  "timestamp": 1774885048909,
  "success": false,
  "code": "SYSTEM.INTERNAL_ERROR",
  "message": "Internal server error",
  "data": null
}

POST `/web/v1/system/slash/connections`

Submits slash connections.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885048916,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/slash/connections/activate`

Submits slash connections activate.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885048927,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/slash/connections/cards/cancel`

Submits slash connections cards cancel.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885049011,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/slash/connections/cards/freeze`

Submits slash connections cards freeze.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885049000,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/slash/connections/cards/unfreeze`

Submits slash connections cards unfreeze.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885049006,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/slash/connections/close`

Submits slash connections close.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{
  "connectionBizId": "non-existent-connection-id"
}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 500)

json

{
  "version": "2.0.0",
  "timestamp": 1774885048948,
  "success": false,
  "code": "SYSTEM.INTERNAL_ERROR",
  "message": "Internal server error",
  "data": null
}

POST `/web/v1/system/slash/connections/suspend`

Submits slash connections suspend.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{
  "connectionBizId": "non-existent-connection-id"
}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 500)

json

{
  "version": "2.0.0",
  "timestamp": 1774885048941,
  "success": false,
  "code": "SYSTEM.INTERNAL_ERROR",
  "message": "Internal server error",
  "data": null
}

Tariffs

GET `/web/v1/system/tariffs/templates`

Reads tariffs templates.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885035072,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": []
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885035076,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

GET `/web/v1/system/tariffs/templates/default`

Reads tariffs templates default.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 404)

json

{
  "version": "2.0.0",
  "timestamp": 1774885035082,
  "success": false,
  "code": "RESOURCE.NOT_FOUND",
  "message": "Resource not found",
  "data": null
}

GET `/web/v1/system/tariffs/templates/non-existent-template-id`

Reads tariffs templates non existent template id.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 404)

json

{
  "version": "2.0.0",
  "timestamp": 1774885035090,
  "success": false,
  "code": "RESOURCE.NOT_FOUND",
  "message": "Resource not found",
  "data": null
}

GET `/web/v1/system/tariffs/wallet`

Reads tariffs wallet.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885035126,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": []
}

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885035129,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

GET `/web/v1/system/tariffs/wallet/non-existent-wallet-id`

Reads tariffs wallet non existent wallet id.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 404)

json

{
  "version": "2.0.0",
  "timestamp": 1774885035135,
  "success": false,
  "code": "RESOURCE.NOT_FOUND",
  "message": "Resource not found",
  "data": null
}

GET `/web/v1/system/tariffs/wallet/non-existent-wallet-id/exists`

Reads tariffs wallet non existent wallet id exists.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885035142,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": false
}

POST `/web/v1/system/tariffs/templates/create`

Submits tariffs templates create.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885035096,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/tariffs/templates/delete`

Submits tariffs templates delete.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885035112,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/tariffs/templates/update`

Submits tariffs templates update.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885035106,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/tariffs/wallet/assign`

Submits tariffs wallet assign.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885035148,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/tariffs/wallet/update`

Submits tariffs wallet update.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{}

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885035155,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

POST `/web/v1/system/tariffs/wallet/workspace/query`

Submits tariffs wallet workspace query.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Request Body:

json

{
  "targetWorkspaceBizId": "HqqrE1zbJSlOJoIW"
}

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885035163,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": []
}

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885035170,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

Transfers

GET `/web/v1/system/transfers/admin/orders/non-existent-order-biz-id`

Reads transfers admin orders non existent order biz id.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 404)

json

{
  "version": "2.0.0",
  "timestamp": 1774885051117,
  "success": false,
  "code": "RESOURCE.NOT_FOUND",
  "message": "Resource not found",
  "data": null
}

GET `/web/v1/system/transfers/admin/orders/non-existent-order-biz-id/completed`

Reads transfers admin orders non existent order biz id completed.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885051155,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": false
}

GET `/web/v1/system/transfers/admin/orders/some-order-biz-id`

Reads transfers admin orders some order biz id.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885051121,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

GET `/web/v1/system/transfers/admin/orders/some-order-biz-id/completed`

Reads transfers admin orders some order biz id completed.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885051159,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

GET `/web/v1/system/transfers/admin/orders/wallet/non-existent-wallet-id`

Reads transfers admin orders wallet non existent wallet id.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
Authorization	Bearer	JWT token (if present in request)
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885051144,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "items": [],
    "pagination": {
      "totalPages": 0,
      "totalRecords": 0,
      "currentPage": 1,
      "pageSize": 0,
      "hasNext": false,
      "empty": true,
      "paginated": false
    }
  }
}

GET `/web/v1/system/transfers/admin/orders/wallet/some-wallet-id`

Reads transfers admin orders wallet some wallet id.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Success Response: Not captured in the provided E2E fixture for this endpoint.

Error Response: (HTTP 401)

json

{
  "version": "2.0.0",
  "timestamp": 1774885051148,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/system/transfers/admin/orders/workspace/query`

Submits transfers admin orders workspace query.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID (if present in request)
X-Request-Id		Unique request ID
X-Client-Hash		Client fingerprint
X-Forwarded-Proto	https	Protocol
CF-Connecting-IP		Client IP
Cf-Ray		Cloudflare ray ID
cf-ipcountry		Client country
X-LOCALE		Locale
Content-Type	application/json	Content type

Optional Headers:

Header	Value	Description
Authorization	Bearer	JWT token (if present in request)

Request Body:

json

{
  "targetWorkspaceBizId": "HqqrE1zbJSlOJoIW",
  "startTime": null,
  "endTime": null,
  "page": 0,
  "size": 20
}

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885051127,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "items": [],
    "pagination": {
      "totalPages": 0,
      "totalRecords": 0,
      "currentPage": 1,
      "pageSize": 0,
      "hasNext": false,
      "empty": true,
      "paginated": false
    }
  }
}

Error Response: (HTTP 400)

json

{
  "version": "2.0.0",
  "timestamp": 1774885051133,
  "success": false,
  "code": "VALIDATION.INVALID_PARAMETER",
  "message": "Invalid request parameters",
  "data": null
}

SYSTEM Portal — WEB Chain Endpoint Reference ​

Auth ​

POST /web/v1/system/auth/login/complete ​

POST /web/v1/system/auth/login/initiate ​

POST /web/v1/system/auth/login/mfa/send ​

POST /web/v1/system/auth/logout ​

POST /web/v1/system/auth/password/change ​

POST /web/v1/system/auth/password/forgot ​

POST /web/v1/system/auth/password/init ​

POST /web/v1/system/auth/password/reset ​

POST /web/v1/system/auth/token/refresh ​

Security ​

GET /web/v1/system/security/ip-whitelist ​

GET /web/v1/system/security/mfa ​

GET /web/v1/system/security/mfa/backup-codes ​

GET /web/v1/system/security/sessions ​

GET /web/v1/system/security/sessions/config ​

GET /web/v1/system/security/sessions/history ​

POST /web/v1/system/security/ip-whitelist ​

POST /web/v1/system/security/ip-whitelist/disable ​

POST /web/v1/system/security/ip-whitelist/enable ​

POST /web/v1/system/security/mfa/backup-codes/generate ​

POST /web/v1/system/security/mfa/otp/revoke ​

POST /web/v1/system/security/mfa/otp/setup ​

POST /web/v1/system/security/mfa/otp/verify ​

POST /web/v1/system/security/sessions/config ​

POST /web/v1/system/security/sessions/terminate ​

POST /web/v1/system/security/sessions/terminate-all ​

Profile ​

GET /web/v1/system/profile ​

GET /web/v1/system/profile/invitations ​

POST /web/v1/system/profile/invitations/accept ​

POST /web/v1/system/profile/invitations/decline ​

POST /web/v1/system/profile/update ​

Workspaces ​

GET /web/v1/system/workspaces/current ​

GET /web/v1/system/workspaces/mine ​

POST /web/v1/system/workspaces ​

POST /web/v1/system/workspaces/admin/account-init-records/resend ​

POST /web/v1/system/workspaces/admin/lookup ​

POST /web/v1/system/workspaces/admin/ownership/transfer ​

POST /web/v1/system/workspaces/admin/query ​

POST /web/v1/system/workspaces/admin/status ​

POST /web/v1/system/workspaces/admin/update ​

POST /web/v1/system/workspaces/current/default ​

POST /web/v1/system/workspaces/current/update ​

Files ​

GET /web/v1/system/files/non-existent-file-biz-id ​

GET /web/v1/system/files/non-existent-file-biz-id/download ​

GET /web/v1/system/files/non-existent-file-biz-id/download-url ​

GET /web/v1/system/files/some-file-biz-id ​

GET /web/v1/system/files/some-file-biz-id/download ​

POST /web/v1/system/files/delete ​

POST /web/v1/system/files/query ​

POST /web/v1/system/files/upload ​

Accounts ​

GET /web/v1/system/accounts/admin/non-existent-user-biz-id ​

GET /web/v1/system/accounts/admin/some-user-biz-id ​

POST /web/v1/system/accounts/admin/password/reset ​

POST /web/v1/system/accounts/admin/query ​

POST /web/v1/system/accounts/admin/status ​

POST /web/v1/system/accounts/admin/update ​

Constants ​

GET /web/v1/system/constants/countries ​

GET /web/v1/system/constants/currency-config-statuses ​

GET /web/v1/system/constants/notification-channel-statuses ​

GET /web/v1/system/constants/notification-channel-type-statuses ​

GET /web/v1/system/constants/notification-channel-types ​

GET /web/v1/system/constants/order-statuses ​

GET /web/v1/system/constants/timezones ​

GET /web/v1/system/constants/transfer-statuses ​

GET /web/v1/system/constants/us-states ​

GET /web/v1/system/constants/user-account-statuses ​

GET /web/v1/system/constants/user-institution-statuses ​

GET /web/v1/system/constants/user-institution-types ​

GET /web/v1/system/constants/user-invitation-statuses ​

GET /web/v1/system/constants/user-join-sources ​

GET /web/v1/system/constants/user-mfa-methods ​

GET /web/v1/system/constants/user-permission-statuses ​

GET /web/v1/system/constants/user-permission-types ​

SYSTEM Portal — WEB Chain Endpoint Reference

Auth

POST `/web/v1/system/auth/login/complete`

POST `/web/v1/system/auth/login/initiate`

POST `/web/v1/system/auth/login/mfa/send`

POST `/web/v1/system/auth/logout`

POST `/web/v1/system/auth/password/change`

POST `/web/v1/system/auth/password/forgot`

POST `/web/v1/system/auth/password/init`

POST `/web/v1/system/auth/password/reset`

POST `/web/v1/system/auth/token/refresh`

Security

GET `/web/v1/system/security/ip-whitelist`

GET `/web/v1/system/security/mfa`

GET `/web/v1/system/security/mfa/backup-codes`

GET `/web/v1/system/security/sessions`

GET `/web/v1/system/security/sessions/config`

GET `/web/v1/system/security/sessions/history`

POST `/web/v1/system/security/ip-whitelist`

POST `/web/v1/system/security/ip-whitelist/disable`

POST `/web/v1/system/security/ip-whitelist/enable`

POST `/web/v1/system/security/mfa/backup-codes/generate`

POST `/web/v1/system/security/mfa/otp/revoke`

POST `/web/v1/system/security/mfa/otp/setup`

POST `/web/v1/system/security/mfa/otp/verify`

POST `/web/v1/system/security/sessions/config`

POST `/web/v1/system/security/sessions/terminate`

POST `/web/v1/system/security/sessions/terminate-all`

Profile

GET `/web/v1/system/profile`

GET `/web/v1/system/profile/invitations`

POST `/web/v1/system/profile/invitations/accept`

POST `/web/v1/system/profile/invitations/decline`

POST `/web/v1/system/profile/update`

Workspaces

GET `/web/v1/system/workspaces/current`

GET `/web/v1/system/workspaces/mine`

POST `/web/v1/system/workspaces`

POST `/web/v1/system/workspaces/admin/account-init-records/resend`

POST `/web/v1/system/workspaces/admin/lookup`

POST `/web/v1/system/workspaces/admin/ownership/transfer`

POST `/web/v1/system/workspaces/admin/query`

POST `/web/v1/system/workspaces/admin/status`

POST `/web/v1/system/workspaces/admin/update`

POST `/web/v1/system/workspaces/current/default`

POST `/web/v1/system/workspaces/current/update`

Files

GET `/web/v1/system/files/non-existent-file-biz-id`

GET `/web/v1/system/files/non-existent-file-biz-id/download`

GET `/web/v1/system/files/non-existent-file-biz-id/download-url`

GET `/web/v1/system/files/some-file-biz-id`

GET `/web/v1/system/files/some-file-biz-id/download`

POST `/web/v1/system/files/delete`

POST `/web/v1/system/files/query`

POST `/web/v1/system/files/upload`

Accounts

GET `/web/v1/system/accounts/admin/non-existent-user-biz-id`

GET `/web/v1/system/accounts/admin/some-user-biz-id`

POST `/web/v1/system/accounts/admin/password/reset`

POST `/web/v1/system/accounts/admin/query`

POST `/web/v1/system/accounts/admin/status`

POST `/web/v1/system/accounts/admin/update`

Constants

GET `/web/v1/system/constants/countries`

GET `/web/v1/system/constants/currency-config-statuses`

GET `/web/v1/system/constants/notification-channel-statuses`

GET `/web/v1/system/constants/notification-channel-type-statuses`

GET `/web/v1/system/constants/notification-channel-types`

GET `/web/v1/system/constants/order-statuses`

GET `/web/v1/system/constants/timezones`

GET `/web/v1/system/constants/transfer-statuses`

GET `/web/v1/system/constants/us-states`

GET `/web/v1/system/constants/user-account-statuses`

GET `/web/v1/system/constants/user-institution-statuses`

GET `/web/v1/system/constants/user-institution-types`

GET `/web/v1/system/constants/user-invitation-statuses`

GET `/web/v1/system/constants/user-join-sources`

GET `/web/v1/system/constants/user-mfa-methods`

GET `/web/v1/system/constants/user-permission-statuses`

GET `/web/v1/system/constants/user-permission-types`