CONSUMER Portal — WEB Chain Endpoint Reference (E2E Verified)

Total endpoints: 90

Examples are sourced from verified E2E fixtures and sanitized ({token}, pac_xxx, {sessionId}). Large arrays are truncated to the first 2 items.

Auth

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

Handles login initiate in the auth domain.

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:None captured in E2E requests.

Request Body:

json

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

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885047208,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "sessionId": "{sessionId}",
    "mfaMethods": [
      {
        "code": "EMAIL",
        "value": 10011001,
        "label": "Email",
        "description": "Email verification code"
      },
      {
        "code": "BACKUP_CODE",
        "value": 10011005,
        "label": "Backup Code",
        "description": "Recovery backup codes"
      }
    ],
    "expiresIn": 300,
    "accountStatus": null,
    "pendingApproval": false
  }
}

Error Response: (HTTP 401)

json

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

POST `/web/v1/consumer/auth/logout`

Handles logout in the auth domain.

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 (optional, based on scenario)

Request Body:

json

null

Success Response: (HTTP 200)

json

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

Error Response: (HTTP 401)

json

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

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

Handles password forgot in the auth domain.

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:None captured in E2E requests.

Request Body:

json

{
  "email": "consumer@slaunchx.test",
  "turnstileToken": "1x00000000000000000000AA"
}

Success Response: (HTTP 200)

json

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

Error Response: (HTTP 400)

json

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

POST `/web/v1/consumer/auth/register/initiate`

Handles register initiate in the auth domain.

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:None captured in E2E requests.

Request Body:

json

{}

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 400)

json

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

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

Handles token refresh in the auth domain.

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:None captured in E2E requests.

Request Body:

json

{
  "refreshToken": "{token}"
}

Success Response: (HTTP 200)

json

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

Error Response: (HTTP 404)

json

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

Security

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

Handles public key in the secure channel domain.

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:None captured in E2E requests.

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054377,
  "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
  }
}

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

Handles session in the secure channel domain.

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:None captured in E2E requests.

Request Body:

json

{}

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 400)

json

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

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

Handles session close in the secure channel domain.

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
X-SC-Session-Id		Secure channel session ID

Request Body:

json

null

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885054394,
  "success": true,
  "code": "2004",
  "message": "No Content",
  "data": null
}

Error Response: (HTTP 500)

json

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

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

Handles ip whitelist in the security domain.

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 (optional, based on scenario)

Success Response: (HTTP 200)

json

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

Error Response: (HTTP 401)

json

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

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

Handles ip whitelist in the security domain.

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 (optional, based on scenario)

Request Body:

json

{
  "addresses": [
    "192.168.1.0/24"
  ]
}

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 400)

json

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

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

Handles ip whitelist disable in the security domain.

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 (optional, based on scenario)

Request Body:

json

null

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885049348,
  "success": true,
  "code": "2004",
  "message": "No Content",
  "data": null
}

Error Response: (HTTP 401)

json

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

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

Handles ip whitelist enable in the security domain.

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 (optional, based on scenario)

Request Body:

json

null

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885049341,
  "success": true,
  "code": "2004",
  "message": "No Content",
  "data": null
}

Error Response: (HTTP 401)

json

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

GET `/web/v1/consumer/security/mfa`

Handles mfa in the security domain.

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 (optional, based on scenario)

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885049219,
  "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": 1774885049222,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

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

Handles mfa backup codes in the security domain.

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 (optional, based on scenario)

Success Response: (HTTP 200)

json

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

Error Response: (HTTP 401)

json

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

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

Handles mfa backup codes generate in the security domain.

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 (optional, based on scenario)

Request Body:

json

null

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 500)

json

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

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

Handles mfa otp revoke in the security domain.

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 (optional, based on scenario)

Request Body:

json

null

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 400)

json

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

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

Handles mfa otp setup in the security domain.

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 (optional, based on scenario)

Request Body:

json

null

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885049226,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "secret": "G4FFUR3PT7VANTV644ASOSY3FN242MMH",
    "qrCodeUri": "otpauth://totp/SlaunchX:consumer@slaunchx.test?secret=G4FFUR3PT7VANTV644ASOSY3FN242MMH&issuer=SlaunchX",
    "issuer": "SlaunchX",
    "accountName": "consumer@slaunchx.test"
  }
}

Error Response: (HTTP 401)

json

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

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

Handles mfa otp verify in the security domain.

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 (optional, based on scenario)

Request Body:

json

{}

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 400)

json

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

GET `/web/v1/consumer/security/sessions`

Handles sessions in the security domain.

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 (optional, based on scenario)

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885049292,
  "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:29.212709502Z",
      "lastActivityTime": "2026-03-30T15:37:29.212709502Z",
      "isCurrent": true
    }
  ]
}

Error Response: (HTTP 401)

json

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

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

Handles sessions config in the security domain.

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 (optional, based on scenario)

Success Response: (HTTP 200)

json

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

Error Response: (HTTP 401)

json

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

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

Handles sessions config in the security domain.

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 (optional, based on scenario)

Request Body:

json

{
  "maxConcurrentSessions": 5
}

Success Response: (HTTP 200)

json

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

Error Response: (HTTP 401)

json

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

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

Handles sessions history in the security domain.

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 (optional, based on scenario)

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885049315,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "items": [
      {
        "bizId": "lh-0edfcd10-7547-4e7a-8680-8c4aca4bc85a",
        "loginTime": "2026-03-30T15:37:29.213670Z",
        "clientIp": "127.0.0.1",
        "userAgent": "slaunchx-doc-verify/1.0",
        "loginResult": 1,
        "failureReason": null
      },
      {
        "bizId": "lh-8c6ef2b7-f410-4e18-a07b-568c4caf24f9",
        "loginTime": "2026-03-30T15:37:27.496667Z",
        "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": 1774885049318,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

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

Handles sessions terminate in the security domain.

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 (optional, based on scenario)

Request Body:

json

{
  "sessionId": "{sessionId}"
}

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885049302,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": null
}

Error Response: (HTTP 400)

json

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

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

Handles sessions terminate all in the security domain.

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:None captured in E2E requests.

Request Body:

json

null

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 401)

json

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

Profile

GET `/web/v1/consumer/api-keys`

Handles operations in the api keys domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885029482,
  "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": 1774885029486,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/consumer/api-keys`

Handles operations in the api keys domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Request Body:

json

{}

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 400)

json

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

GET `/web/v1/consumer/api-keys/available-permissions`

Handles available permissions in the api keys domain.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID
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 (optional, based on scenario)

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885029495,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    "wallet:read",
    "transfer:read"
  ]
}

Error Response: (HTTP 401)

json

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

POST `/web/v1/consumer/api-keys/delete`

Handles delete in the api keys domain.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID
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 (optional, based on scenario)

Request Body:

json

{}

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 400)

json

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

POST `/web/v1/consumer/api-keys/disable`

Handles disable in the api keys domain.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID
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 (optional, based on scenario)

Request Body:

json

{}

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 400)

json

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

POST `/web/v1/consumer/api-keys/enable`

Handles enable in the api keys domain.

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
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:None captured in E2E requests.

Request Body:

json

{}

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 400)

json

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

GET `/web/v1/consumer/api-keys/non-existent-key-id`

Handles non existent key id in the api keys domain.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID
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 (optional, based on scenario)

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 404)

json

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

GET `/web/v1/consumer/invitations`

Handles operations in the invitations domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Success Response: (HTTP 200)

json

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

Error Response: (HTTP 401)

json

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

POST `/web/v1/consumer/invitations`

Handles operations in the invitations domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Request Body:

json

{}

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 400)

json

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

POST `/web/v1/consumer/invitations/cancel`

Handles cancel in the invitations domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Request Body:

json

{}

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 400)

json

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

GET `/web/v1/consumer/profile`

Handles operations in the profile domain.

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 (optional, based on scenario)

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885029723,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "cNAnIHv1IKEIb6cs",
    "institutionBizId": "pekOCmPDkN18jQXf",
    "accountEmail": "consumer@slaunchx.test",
    "accountPhone": "+10000000001",
    "accountName": "Consumer Test User",
    "accountRemark": null,
    "accountPortal": {
      "code": "CONSUMER",
      "value": 10010104,
      "label": "Consumer Portal",
      "description": "Consumer portal for end users"
    },
    "accountStatus": {
      "code": "ACTIVE",
      "value": 10010202,
      "label": "Active",
      "description": "Account is active and usable"
    },
    "createdAt": "2026-03-30T15:33:08.995476Z",
    "updatedAt": "2026-03-30T15:34:15.587845Z",
    "defaultLanguage": "en",
    "defaultTimezone": "UTC",
    "defaultCountry": "US"
  }
}

Error Response: (HTTP 401)

json

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

GET `/web/v1/consumer/profile/invitations`

Handles invitations in the profile domain.

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 (optional, based on scenario)

Success Response: (HTTP 200)

json

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

Error Response: (HTTP 401)

json

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

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

Handles invitations accept in the profile domain.

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 (optional, based on scenario)

Request Body:

json

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

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 400)

json

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

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

Handles invitations decline in the profile domain.

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 (optional, based on scenario)

Request Body:

json

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

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 400)

json

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

POST `/web/v1/consumer/profile/update`

Handles update in the profile domain.

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 (optional, based on scenario)

Request Body:

json

{
  "accountName": "Consumer Test User",
  "accountPhone": "+10000000001",
  "defaultLanguage": "en",
  "defaultTimezone": "UTC",
  "defaultCountry": "US"
}

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885029733,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "cNAnIHv1IKEIb6cs",
    "institutionBizId": "pekOCmPDkN18jQXf",
    "accountEmail": "consumer@slaunchx.test",
    "accountPhone": "+10000000001",
    "accountName": "Consumer Test User",
    "accountRemark": null,
    "accountPortal": {
      "code": "CONSUMER",
      "value": 10010104,
      "label": "Consumer Portal",
      "description": "Consumer portal for end users"
    },
    "accountStatus": {
      "code": "ACTIVE",
      "value": 10010202,
      "label": "Active",
      "description": "Account is active and usable"
    },
    "createdAt": "2026-03-30T15:33:08.995476Z",
    "updatedAt": "2026-03-30T15:37:09.732858249Z",
    "defaultLanguage": "en",
    "defaultTimezone": "UTC",
    "defaultCountry": "US"
  }
}

Error Response: (HTTP 401)

json

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

GET `/web/v1/consumer/roles`

Handles operations in the roles domain.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID
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 (optional, based on scenario)

Success Response: (HTTP 200)

json

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

Error Response: (HTTP 401)

json

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

POST `/web/v1/consumer/roles`

Handles operations in the roles domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Request Body:

json

{}

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 400)

json

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

POST `/web/v1/consumer/roles/delete`

Handles delete in the roles domain.

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
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:None captured in E2E requests.

Request Body:

json

{}

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 400)

json

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

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

Handles members role change in the roles domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Request Body:

json

{}

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 400)

json

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

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

Handles non existent role id in the roles domain.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID
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 (optional, based on scenario)

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 404)

json

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

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

Handles non existent role id permissions in the roles domain.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID
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 (optional, based on scenario)

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 404)

json

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

POST `/web/v1/consumer/roles/permissions`

Handles permissions in the roles domain.

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
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:None captured in E2E requests.

Request Body:

json

{}

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 400)

json

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

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

Handles permissions tree in the roles domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885030880,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "bizId": "64db79b4-af35-4101-8f76-a1096183df5a",
      "permissionCode": "apikey:read",
      "permissionName": "Apikey Read",
      "permissionDescription": null,
      "parentBizId": null,
      "permissionGroup": "apikey",
      "portalVisibility": null,
      "sortOrder": 1,
      "isEnabled": true,
      "children": []
    },
    {
      "bizId": "09ef9df3-7434-4e2a-8e78-4b25cd64db34",
      "permissionCode": "apikey:write",
      "permissionName": "Apikey Write",
      "permissionDescription": null,
      "parentBizId": null,
      "permissionGroup": "apikey",
      "portalVisibility": null,
      "sortOrder": 2,
      "isEnabled": true,
      "children": []
    }
  ]
}

Error Response: (HTTP 401)

json

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

POST `/web/v1/consumer/roles/update`

Handles update in the roles domain.

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
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:None captured in E2E requests.

Request Body:

json

{}

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 400)

json

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

Workspace

POST `/web/v1/consumer/workspaces`

Handles operations in the workspaces domain.

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 (optional, based on scenario)

Request Body:

json

{}

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 400)

json

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

GET `/web/v1/consumer/workspaces/current`

Handles current in the workspaces domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885032520,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "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"
  }
}

Error Response: (HTTP 401)

json

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

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

Handles current default in the workspaces domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Request Body:

json

null

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885032549,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "userBizId": "cNAnIHv1IKEIb6cs",
    "workspaceBizId": "bTzedK3pE7KtfnkK",
    "workspaceName": "Doc-Verify Consumer WS",
    "workspaceKind": {
      "code": "LIVE",
      "value": 10050101,
      "label": "Live",
      "description": "Primary workspace for production business operations"
    },
    "institutionBizId": "pekOCmPDkN18jQXf",
    "workspaceRoleBizId": "JPX1yjU6JsbTMcDH",
    "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:33:09.504146Z",
    "updatedAt": "2026-03-30T15:37:12.547737027Z"
  }
}

Error Response: (HTTP 401)

json

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

POST `/web/v1/consumer/workspaces/current/leave`

Handles current leave in the workspaces domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Request Body:

json

null

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 401)

json

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

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

Handles current update in the workspaces domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Request Body:

json

{}

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885032535,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "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:37:12.534342551Z"
  }
}

GET `/web/v1/consumer/workspaces/mine`

Handles mine in the workspaces domain.

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 (optional, based on scenario)

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885032511,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "userBizId": "cNAnIHv1IKEIb6cs",
      "workspaceBizId": "bTzedK3pE7KtfnkK",
      "workspaceName": "Doc-Verify Consumer WS",
      "workspaceKind": {
        "code": "LIVE",
        "value": 10050101,
        "label": "Live",
        "description": "Primary workspace for production business operations"
      },
      "institutionBizId": "pekOCmPDkN18jQXf",
      "workspaceRoleBizId": "JPX1yjU6JsbTMcDH",
      "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:33:09.504146Z",
      "updatedAt": "2026-03-30T15:34:13.449404Z"
    }
  ]
}

Error Response: (HTTP 401)

json

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

Billing

GET `/web/v1/consumer/exchanges`

Handles operations in the exchanges domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885027578,
  "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": 1774885027583,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/consumer/exchanges`

Handles operations in the exchanges domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Request Body:

json

{}

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 400)

json

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

GET `/web/v1/consumer/exchanges/non-existent-biz-id`

Handles non existent biz id in the exchanges domain.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID
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 (optional, based on scenario)

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 404)

json

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

POST `/web/v1/consumer/exchanges/quote`

Handles quote in the exchanges domain.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID
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 (optional, based on scenario)

Request Body:

json

{}

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 400)

json

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

GET `/web/v1/consumer/recharges`

Handles operations in the recharges domain.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID
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 (optional, based on scenario)

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885034410,
  "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": 1774885034422,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/consumer/recharges`

Handles operations in the recharges domain.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID
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 (optional, based on scenario)

Request Body:

json

{}

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 400)

json

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

GET `/web/v1/consumer/recharges/available-channels`

Handles available channels in the recharges domain.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID
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 (optional, based on scenario)

Success Response: (HTTP 200)

json

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

Error Response: (HTTP 401)

json

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

GET `/web/v1/consumer/recharges/non-existent-biz-id`

Handles non existent biz id in the recharges domain.

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
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:None captured in E2E requests.

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 404)

json

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

POST `/web/v1/consumer/recharges/non-existent-biz-id/cancel`

Handles non existent biz id cancel in the recharges domain.

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
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:None captured in E2E requests.

Request Body:

json

{
  "cancelReason": "Test cancel"
}

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 404)

json

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

POST `/web/v1/consumer/recharges/non-existent-biz-id/proof`

Handles non existent biz id proof in the recharges domain.

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
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:None captured in E2E requests.

Request Body:

json

{
  "fileBizId": "non-existent-file-id"
}

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 404)

json

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

POST `/web/v1/consumer/recharges/quote`

Handles quote in the recharges domain.

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
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:None captured in E2E requests.

Request Body:

json

{}

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 400)

json

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

POST `/web/v1/consumer/transfer/command/create`

Handles command create in the transfer domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Request Body:

json

{}

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 400)

json

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

GET `/web/v1/consumer/transfer/query/orders`

Handles query orders in the transfer domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 500)

json

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

GET `/web/v1/consumer/transfer/query/orders/non-existent-biz-id`

Handles query orders non existent biz id in the transfer domain.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID
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 (optional, based on scenario)

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 404)

json

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

GET `/web/v1/consumer/transfer/query/orders/non-existent-biz-id/completed`

Handles query orders non existent biz id completed in the transfer domain.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID
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 (optional, based on scenario)

Success Response: (HTTP 200)

json

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

Error Response: (HTTP 401)

json

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

GET `/web/v1/consumer/transfer/query/orders/wallet/non-existent-wallet-id`

Handles query orders wallet non existent wallet id in the transfer domain.

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
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:None captured in E2E requests.

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885028845,
  "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/consumer/withdrawal-channels`

Handles operations in the withdrawal channels domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Success Response: (HTTP 200)

json

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

Error Response: (HTTP 401)

json

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

POST `/web/v1/consumer/withdrawal-channels`

Handles operations in the withdrawal channels domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Request Body:

json

{}

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 400)

json

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

GET `/web/v1/consumer/withdrawals`

Handles operations in the withdrawals domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885029974,
  "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": 1774885029978,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/consumer/withdrawals`

Handles operations in the withdrawals domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Request Body:

json

{}

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 400)

json

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

GET `/web/v1/consumer/withdrawals/non-existent-biz-id`

Handles non existent biz id in the withdrawals domain.

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
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:None captured in E2E requests.

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 404)

json

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

POST `/web/v1/consumer/withdrawals/non-existent-biz-id/cancel`

Handles non existent biz id cancel in the withdrawals domain.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID
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 (optional, based on scenario)

Request Body:

json

null

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 404)

json

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

Wallet

GET `/web/v1/consumer/wallets`

Handles operations in the wallets domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Success Response: (HTTP 200)

json

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

Error Response: (HTTP 401)

json

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

GET `/web/v1/consumer/wallets/non-existent-wallet-id`

Handles non existent wallet id in the wallets domain.

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
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:None captured in E2E requests.

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 404)

json

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

GET `/web/v1/consumer/wallets/non-existent-wallet-id/balance`

Handles non existent wallet id balance in the wallets domain.

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
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:None captured in E2E requests.

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 404)

json

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

GET `/web/v1/consumer/wallets/non-existent-wallet-id/flows`

Handles non existent wallet id flows in the wallets domain.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID
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 (optional, based on scenario)

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 404)

json

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

File

GET `/web/v1/consumer/files/non-existent-file-id`

Handles non existent file id in the files domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 404)

json

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

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

Handles non existent file id download in the files domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 404)

json

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

POST `/web/v1/consumer/files/upload`

Handles upload in the files domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Request Body:

json

null

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 401)

json

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

Export

GET `/web/v1/consumer/exports`

Handles operations in the exports domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885049815,
  "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": 1774885049819,
  "success": false,
  "code": "ACCESS.TOKEN_MISSING",
  "message": "Authentication token is required",
  "data": null
}

POST `/web/v1/consumer/exports`

Handles operations in the exports domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Request Body:

json

{}

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 400)

json

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

GET `/web/v1/consumer/exports/non-existent-biz-id`

Handles non existent biz id in the exports domain.

Required Headers:

Header	Value	Description
X-PORTAL-ACCESS-CODE	pac_xxx	Portal access code
X-Workspace-Id		Workspace ID
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 (optional, based on scenario)

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 404)

json

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

GET `/web/v1/consumer/exports/non-existent-biz-id/download`

Handles non existent biz id download in the exports domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Success Response: No success example was captured in the current E2E fixture.

Error Response: (HTTP 404)

json

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

System

GET `/web/v1/consumer/constants/countries`

Handles countries in the constants domain.

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:None captured in E2E requests.

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885053917,
  "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"
    }
  ]
}

GET `/web/v1/consumer/constants/timezones`

Handles timezones in the constants domain.

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:None captured in E2E requests.

Success Response: (HTTP 200)

json

{
  "version": "2.0.0",
  "timestamp": 1774885053913,
  "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"
    }
  ]
}

POST `/web/v1/consumer/sandbox/reset`

Handles reset in the sandbox domain.

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 (optional, based on scenario)
X-Workspace-Id		Workspace ID

Request Body:

json

null

Success Response: (HTTP 403)

json

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

Error Response: (HTTP 401)

json

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

CONSUMER Portal — WEB Chain Endpoint Reference (E2E Verified) ​

Auth ​

POST /web/v1/consumer/auth/login/initiate ​

POST /web/v1/consumer/auth/logout ​

POST /web/v1/consumer/auth/password/forgot ​

POST /web/v1/consumer/auth/register/initiate ​

POST /web/v1/consumer/auth/token/refresh ​

Security ​

GET /web/v1/consumer/secure-channel/public-key ​

POST /web/v1/consumer/secure-channel/session ​

POST /web/v1/consumer/secure-channel/session/close ​

GET /web/v1/consumer/security/ip-whitelist ​

POST /web/v1/consumer/security/ip-whitelist ​

POST /web/v1/consumer/security/ip-whitelist/disable ​

POST /web/v1/consumer/security/ip-whitelist/enable ​

GET /web/v1/consumer/security/mfa ​

GET /web/v1/consumer/security/mfa/backup-codes ​

POST /web/v1/consumer/security/mfa/backup-codes/generate ​

POST /web/v1/consumer/security/mfa/otp/revoke ​

POST /web/v1/consumer/security/mfa/otp/setup ​

POST /web/v1/consumer/security/mfa/otp/verify ​

GET /web/v1/consumer/security/sessions ​

GET /web/v1/consumer/security/sessions/config ​

POST /web/v1/consumer/security/sessions/config ​

GET /web/v1/consumer/security/sessions/history ​

POST /web/v1/consumer/security/sessions/terminate ​

POST /web/v1/consumer/security/sessions/terminate-all ​

Profile ​

GET /web/v1/consumer/api-keys ​

POST /web/v1/consumer/api-keys ​

GET /web/v1/consumer/api-keys/available-permissions ​

POST /web/v1/consumer/api-keys/delete ​

POST /web/v1/consumer/api-keys/disable ​

POST /web/v1/consumer/api-keys/enable ​

GET /web/v1/consumer/api-keys/non-existent-key-id ​

GET /web/v1/consumer/invitations ​

POST /web/v1/consumer/invitations ​

POST /web/v1/consumer/invitations/cancel ​

GET /web/v1/consumer/profile ​

GET /web/v1/consumer/profile/invitations ​

POST /web/v1/consumer/profile/invitations/accept ​

POST /web/v1/consumer/profile/invitations/decline ​

POST /web/v1/consumer/profile/update ​

GET /web/v1/consumer/roles ​

POST /web/v1/consumer/roles ​

POST /web/v1/consumer/roles/delete ​

POST /web/v1/consumer/roles/members/role/change ​

GET /web/v1/consumer/roles/non-existent-role-id ​

GET /web/v1/consumer/roles/non-existent-role-id/permissions ​

POST /web/v1/consumer/roles/permissions ​

GET /web/v1/consumer/roles/permissions/tree ​

POST /web/v1/consumer/roles/update ​

Workspace ​

POST /web/v1/consumer/workspaces ​

GET /web/v1/consumer/workspaces/current ​

POST /web/v1/consumer/workspaces/current/default ​

POST /web/v1/consumer/workspaces/current/leave ​

POST /web/v1/consumer/workspaces/current/update ​

GET /web/v1/consumer/workspaces/mine ​

Billing ​

GET /web/v1/consumer/exchanges ​

POST /web/v1/consumer/exchanges ​

GET /web/v1/consumer/exchanges/non-existent-biz-id ​

POST /web/v1/consumer/exchanges/quote ​

GET /web/v1/consumer/recharges ​

POST /web/v1/consumer/recharges ​

GET /web/v1/consumer/recharges/available-channels ​

GET /web/v1/consumer/recharges/non-existent-biz-id ​

POST /web/v1/consumer/recharges/non-existent-biz-id/cancel ​

POST /web/v1/consumer/recharges/non-existent-biz-id/proof ​

POST /web/v1/consumer/recharges/quote ​

POST /web/v1/consumer/transfer/command/create ​

GET /web/v1/consumer/transfer/query/orders ​

GET /web/v1/consumer/transfer/query/orders/non-existent-biz-id ​

GET /web/v1/consumer/transfer/query/orders/non-existent-biz-id/completed ​

GET /web/v1/consumer/transfer/query/orders/wallet/non-existent-wallet-id ​

GET /web/v1/consumer/withdrawal-channels ​

POST /web/v1/consumer/withdrawal-channels ​

GET /web/v1/consumer/withdrawals ​

POST /web/v1/consumer/withdrawals ​

CONSUMER Portal — WEB Chain Endpoint Reference (E2E Verified)

Auth

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

POST `/web/v1/consumer/auth/logout`

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

POST `/web/v1/consumer/auth/register/initiate`

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

Security

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

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

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

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

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

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

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

GET `/web/v1/consumer/security/mfa`

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

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

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

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

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

GET `/web/v1/consumer/security/sessions`

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

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

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

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

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

Profile

GET `/web/v1/consumer/api-keys`

POST `/web/v1/consumer/api-keys`

GET `/web/v1/consumer/api-keys/available-permissions`

POST `/web/v1/consumer/api-keys/delete`

POST `/web/v1/consumer/api-keys/disable`

POST `/web/v1/consumer/api-keys/enable`

GET `/web/v1/consumer/api-keys/non-existent-key-id`

GET `/web/v1/consumer/invitations`

POST `/web/v1/consumer/invitations`

POST `/web/v1/consumer/invitations/cancel`

GET `/web/v1/consumer/profile`

GET `/web/v1/consumer/profile/invitations`

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

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

POST `/web/v1/consumer/profile/update`

GET `/web/v1/consumer/roles`

POST `/web/v1/consumer/roles`

POST `/web/v1/consumer/roles/delete`

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

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

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

POST `/web/v1/consumer/roles/permissions`

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

POST `/web/v1/consumer/roles/update`

Workspace

POST `/web/v1/consumer/workspaces`

GET `/web/v1/consumer/workspaces/current`

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

POST `/web/v1/consumer/workspaces/current/leave`

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

GET `/web/v1/consumer/workspaces/mine`

Billing

GET `/web/v1/consumer/exchanges`

POST `/web/v1/consumer/exchanges`

GET `/web/v1/consumer/exchanges/non-existent-biz-id`

POST `/web/v1/consumer/exchanges/quote`

GET `/web/v1/consumer/recharges`

POST `/web/v1/consumer/recharges`

GET `/web/v1/consumer/recharges/available-channels`

GET `/web/v1/consumer/recharges/non-existent-biz-id`

POST `/web/v1/consumer/recharges/non-existent-biz-id/cancel`

POST `/web/v1/consumer/recharges/non-existent-biz-id/proof`

POST `/web/v1/consumer/recharges/quote`

POST `/web/v1/consumer/transfer/command/create`

GET `/web/v1/consumer/transfer/query/orders`

GET `/web/v1/consumer/transfer/query/orders/non-existent-biz-id`

GET `/web/v1/consumer/transfer/query/orders/non-existent-biz-id/completed`

GET `/web/v1/consumer/transfer/query/orders/wallet/non-existent-wallet-id`

GET `/web/v1/consumer/withdrawal-channels`

POST `/web/v1/consumer/withdrawal-channels`

GET `/web/v1/consumer/withdrawals`

POST `/web/v1/consumer/withdrawals`