Partner Portal

English

简体中文

English

简体中文

Appearance

PARTNER Portal — WEB Chain Endpoints ​

Total endpoints: 94

Source fixtures: /home/reynardzhang.linux/workspace/repos/devportal/slaunchx-api-toolkit/doc-verify/data/examples/partner

Sensitive values are sanitized (Bearer {token}, pac_xxx, {sessionId}). Arrays are truncated to the first 2 items.

Auth ​

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

Execute auth login initiate.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Request Body:

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

Success Response: (HTTP 200)

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

Error Response: (HTTP 401)

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

POST /web/v1/partner/auth/logout ​

Execute auth logout.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: (HTTP 200)

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

Error Response: (HTTP 401)

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

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

Execute auth password forgot.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Request Body:

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

Success Response: (HTTP 200)

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

Error Response: (HTTP 400)

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

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

Execute auth token refresh.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Request Body:

json
{
  "refreshToken": "{token}"
}

Success Response: (HTTP 200)

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

Error Response: (HTTP 404)

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

Security ​

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

Retrieve security ip whitelist.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: (HTTP 200)

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

Error Response: (HTTP 401)

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

GET /web/v1/partner/security/mfa ​

Retrieve security mfa.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: (HTTP 200)

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

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

Retrieve security mfa backup codes.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: (HTTP 200)

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

Error Response: (HTTP 401)

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

GET /web/v1/partner/security/sessions ​

Retrieve security sessions.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: (HTTP 200)

json
{
  "version": "2.0.0",
  "timestamp": 1774885031248,
  "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:11.155048143Z",
      "lastActivityTime": "2026-03-30T15:37:11.155048143Z",
      "isCurrent": true
    },
    {
      "sessionId": "{sessionId}",
      "clientIp": "127.0.0.1",
      "userAgent": "slaunchx-doc-verify/1.0",
      "loginTime": "2026-03-30T15:37:10.391032910Z",
      "lastActivityTime": "2026-03-30T15:37:10.391032910Z",
      "isCurrent": false
    }
  ]
}

Error Response: (HTTP 401)

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

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

Retrieve security sessions config.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: (HTTP 200)

json
{
  "version": "2.0.0",
  "timestamp": 1774885031204,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "accountBizId": "2mEWJwUElgHkRrER",
    "ssoEnabled": true,
    "maxSessions": 3,
    "passwordChangedAt": null,
    "lastLoginAt": null,
    "lastLoginIp": null
  }
}

Error Response: (HTTP 401)

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

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

Retrieve security sessions history.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: (HTTP 200)

json
{
  "version": "2.0.0",
  "timestamp": 1774885031270,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "items": [
      {
        "bizId": "lh-eb532d5a-a58e-41e5-8522-fcf279e97342",
        "loginTime": "2026-03-30T15:37:11.156164Z",
        "clientIp": "127.0.0.1",
        "userAgent": "slaunchx-doc-verify/1.0",
        "loginResult": 1,
        "failureReason": null
      },
      {
        "bizId": "lh-42ef7756-48a8-4c27-9b30-e3ad3d754b3d",
        "loginTime": "2026-03-30T15:37:10.391868Z",
        "clientIp": "127.0.0.1",
        "userAgent": "slaunchx-doc-verify/1.0",
        "loginResult": 1,
        "failureReason": null
      }
    ],
    "pagination": {
      "totalPages": 6,
      "totalRecords": 54,
      "currentPage": 1,
      "pageSize": 10,
      "hasNext": true,
      "empty": false,
      "paginated": true
    }
  }
}

Error Response: (HTTP 401)

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

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

Execute security ip whitelist.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Request Body:

json
{
  "ips": [
    "192.168.1.0/24"
  ]
}

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 401)

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

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

Execute security ip whitelist disable.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 401)

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

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

Execute security ip whitelist enable.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 401)

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

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

Execute security mfa backup codes generate.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 401)

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

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

Execute security mfa otp revoke.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 401)

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

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

Execute security mfa otp setup.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 401)

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

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

Execute security mfa otp verify.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Request Body:

json
{}

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 400)

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

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

Execute security sessions config.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Request Body:

json
{
  "maxConcurrentSessions": 5
}

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 401)

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

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

Execute security sessions terminate.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Request Body:

json
{}

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 400)

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

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

Execute security sessions terminate all.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 401)

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

Secure Channel ​

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

Retrieve secure channel public key.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Success Response: (HTTP 200)

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

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

Execute secure channel session.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Request Body:

json
{}

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 400)

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

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

Execute secure channel session close.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
X-SC-Session-IdSecure channel session ID

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 500)

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

Profile ​

GET /web/v1/partner/profile ​

Retrieve profile.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: (HTTP 200)

json
{
  "version": "2.0.0",
  "timestamp": 1774885027054,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "2mEWJwUElgHkRrER",
    "institutionBizId": "pekOCmPDkN18jQXf",
    "accountEmail": "partner@slaunchx.test",
    "accountPhone": "+10000000001",
    "accountName": "Partner Test User",
    "accountRemark": null,
    "accountPortal": {
      "code": "PARTNER",
      "value": 10010103,
      "label": "Partner Portal",
      "description": "Partner portal for channel partners"
    },
    "accountStatus": {
      "code": "ACTIVE",
      "value": 10010202,
      "label": "Active",
      "description": "Account is active and usable"
    },
    "createdAt": "2026-03-30T15:33:08.826311Z",
    "updatedAt": "2026-03-30T15:34:19.083249Z",
    "defaultLanguage": "en",
    "defaultTimezone": "UTC",
    "defaultCountry": "US"
  }
}

Error Response: (HTTP 401)

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

GET /web/v1/partner/profile/invitations ​

Retrieve profile invitations.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: (HTTP 200)

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

Error Response: (HTTP 401)

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

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

Execute profile invitations accept.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Request Body:

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

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 400)

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

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

Execute profile invitations decline.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Request Body:

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

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 400)

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

POST /web/v1/partner/profile/update ​

Execute profile update.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Request Body:

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

Success Response: (HTTP 200)

json
{
  "version": "2.0.0",
  "timestamp": 1774885027064,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "2mEWJwUElgHkRrER",
    "institutionBizId": "pekOCmPDkN18jQXf",
    "accountEmail": "partner@slaunchx.test",
    "accountPhone": "+10000000001",
    "accountName": "Partner Test User",
    "accountRemark": null,
    "accountPortal": {
      "code": "PARTNER",
      "value": 10010103,
      "label": "Partner Portal",
      "description": "Partner portal for channel partners"
    },
    "accountStatus": {
      "code": "ACTIVE",
      "value": 10010202,
      "label": "Active",
      "description": "Account is active and usable"
    },
    "createdAt": "2026-03-30T15:33:08.826311Z",
    "updatedAt": "2026-03-30T15:37:07.063354374Z",
    "defaultLanguage": "en",
    "defaultTimezone": "UTC",
    "defaultCountry": "US"
  }
}

Error Response: (HTTP 401)

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

Workspace ​

GET /web/v1/partner/workspaces/current ​

Retrieve workspaces current.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token
X-Workspace-IdWorkspace ID

Success Response: (HTTP 200)

json
{
  "version": "2.0.0",
  "timestamp": 1774885030193,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "XN6e38nLOpxOWUT9",
    "institutionBizId": "pekOCmPDkN18jQXf",
    "entityBizId": null,
    "workspaceName": "Partner Test Workspace",
    "workspaceTimezone": "UTC",
    "workspaceStatus": {
      "code": "ACTIVE",
      "value": 10010304,
      "label": "Active",
      "description": "Workspace is active and tenant verified"
    },
    "workspaceKind": {
      "code": "LIVE",
      "value": 10050101,
      "label": "Live",
      "description": "Primary workspace for production business operations"
    },
    "extraData": null,
    "createdAt": "2026-03-30T15:33:09.321412Z",
    "updatedAt": "2026-03-30T15:34:18.014615Z"
  }
}

Error Response: (HTTP 400)

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

GET /web/v1/partner/workspaces/mine ​

Retrieve workspaces mine.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: (HTTP 200)

json
{
  "version": "2.0.0",
  "timestamp": 1774885030185,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": [
    {
      "userBizId": "2mEWJwUElgHkRrER",
      "workspaceBizId": "XN6e38nLOpxOWUT9",
      "workspaceName": "Partner Test Workspace",
      "workspaceKind": {
        "code": "LIVE",
        "value": 10050101,
        "label": "Live",
        "description": "Primary workspace for production business operations"
      },
      "institutionBizId": "pekOCmPDkN18jQXf",
      "workspaceRoleBizId": "d906DWjo3jvBy4Hv",
      "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.321412Z",
      "updatedAt": "2026-03-30T15:34:18.024306Z"
    }
  ]
}

Error Response: (HTTP 401)

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

POST /web/v1/partner/workspaces ​

Execute workspaces.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Request Body:

json
{}

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 400)

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

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

Execute workspaces current default.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: (HTTP 200)

json
{
  "version": "2.0.0",
  "timestamp": 1774885030216,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "userBizId": "2mEWJwUElgHkRrER",
    "workspaceBizId": "XN6e38nLOpxOWUT9",
    "workspaceName": "Partner Test Workspace",
    "workspaceKind": {
      "code": "LIVE",
      "value": 10050101,
      "label": "Live",
      "description": "Primary workspace for production business operations"
    },
    "institutionBizId": "pekOCmPDkN18jQXf",
    "workspaceRoleBizId": "d906DWjo3jvBy4Hv",
    "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.321412Z",
    "updatedAt": "2026-03-30T15:37:10.215409477Z"
  }
}

Error Response: (HTTP 401)

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

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

Execute workspaces current leave.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 401)

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

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

Execute workspaces current update.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Request Body:

json
{
  "workspaceName": "Partner Test Workspace",
  "workspaceTimezone": "UTC"
}

Success Response: (HTTP 200)

json
{
  "version": "2.0.0",
  "timestamp": 1774885030207,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "XN6e38nLOpxOWUT9",
    "institutionBizId": "pekOCmPDkN18jQXf",
    "entityBizId": null,
    "workspaceName": "Partner Test Workspace",
    "workspaceTimezone": "UTC",
    "workspaceStatus": {
      "code": "ACTIVE",
      "value": 10010304,
      "label": "Active",
      "description": "Workspace is active and tenant verified"
    },
    "workspaceKind": {
      "code": "LIVE",
      "value": 10050101,
      "label": "Live",
      "description": "Primary workspace for production business operations"
    },
    "extraData": null,
    "createdAt": "2026-03-30T15:33:09.321412Z",
    "updatedAt": "2026-03-30T15:37:10.206547405Z"
  }
}

Error Response: (HTTP 401)

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

API Keys ​

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

Retrieve api keys.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: (HTTP 200)

json
{
  "version": "2.0.0",
  "timestamp": 1774885025660,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "items": [
      {
        "apiKeyId": "sk_live_eaa23c6da9634f8cb3e9",
        "name": "DocVerify Test Key 1774885025639",
        "status": "ACTIVE",
        "mode": "LIVE",
        "permissions": [
          "wallet:read"
        ],
        "ipWhitelist": [
          "127.0.0.1"
        ],
        "createdAt": "2026-03-30T15:37:05.644747Z",
        "lastUsedAt": null,
        "createdBy": "2mEWJwUElgHkRrER"
      },
      {
        "apiKeyId": "sk_live_3a354b2beeea483d9610",
        "name": "DocVerify Test Key 1774884854426",
        "status": "ACTIVE",
        "mode": "LIVE",
        "permissions": [
          "wallet:read"
        ],
        "ipWhitelist": [
          "127.0.0.1"
        ],
        "createdAt": "2026-03-30T15:34:14.432295Z",
        "lastUsedAt": null,
        "createdBy": "2mEWJwUElgHkRrER"
      }
    ],
    "pagination": {
      "totalPages": 1,
      "totalRecords": 3,
      "currentPage": 1,
      "pageSize": 3,
      "hasNext": false,
      "empty": false,
      "paginated": false
    }
  }
}

Error Response: (HTTP 401)

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

GET /web/v1/partner/api-keys/{keyBizId} ​

Retrieve api keys by ID.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
AuthorizationBearerJWT token
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Success Response: (HTTP 404)

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

Error Response: (HTTP 404)

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

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

Retrieve api keys available permissions.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: (HTTP 200)

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

Error Response: (HTTP 401)

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

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

Execute api keys.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Request Body:

json
{
  "name": "DocVerify Test Key 1774885025639",
  "scopes": [
    "wallet:read"
  ],
  "ipWhitelist": [
    "127.0.0.1"
  ]
}

Success Response: (HTTP 201)

json
{
  "version": "2.0.0",
  "timestamp": 1774885025645,
  "success": true,
  "code": "2001",
  "message": "Created",
  "data": {
    "apiKeyId": "sk_live_eaa23c6da9634f8cb3e9",
    "secret": "db85f21f1c5f2dd56e32a8a28321e13a0ad44ebbeaadada187172d071e646f70",
    "name": "DocVerify Test Key 1774885025639",
    "status": "ACTIVE",
    "mode": "LIVE",
    "scopes": [
      "wallet:read"
    ],
    "ipWhitelist": [
      "127.0.0.1"
    ],
    "createdAt": "2026-03-30T15:37:05.644746886Z"
  }
}

Error Response: (HTTP 400)

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

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

Execute api keys delete.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Request Body:

json
{}

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 400)

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

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

Execute api keys disable.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
AuthorizationBearerJWT token
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Request Body:

json
{}

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 400)

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

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

Execute api keys enable.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
AuthorizationBearerJWT token
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Request Body:

json
{}

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 400)

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

Roles ​

GET /web/v1/partner/roles ​

Retrieve roles.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: (HTTP 200)

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

Error Response: (HTTP 401)

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

GET /web/v1/partner/roles/{roleBizId} ​

Retrieve roles by ID.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
AuthorizationBearerJWT token
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Success Response: (HTTP 200)

json
{
  "version": "2.0.0",
  "timestamp": 1774879281356,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "7juRyy9KxbAeHFAi",
    "workspaceBizId": "ZMgRvVoq2JlCbsCy",
    "roleName": "DocVerify Test Role 1774879281327",
    "roleType": {
      "code": "CUSTOM",
      "value": 10010902,
      "label": "Custom",
      "description": "Custom defined role"
    },
    "description": "Created by doc-verify E2E test suite",
    "permissionCodes": [],
    "createdAt": "2026-03-30T14:01:21.332263Z",
    "updatedAt": "2026-03-30T14:01:21.332263Z"
  }
}

Error Response: (HTTP 404)

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

GET /web/v1/partner/roles/{roleBizId}/permissions ​

Retrieve roles by ID permissions.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
AuthorizationBearerJWT token
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Success Response: (HTTP 200)

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

Error Response: (HTTP 404)

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

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

Retrieve roles permissions tree.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: (HTTP 200)

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

POST /web/v1/partner/roles ​

Execute roles.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Request Body:

json
{
  "roleName": "DocVerify Test Role 1774885031458",
  "description": "Created by doc-verify E2E test suite"
}

Success Response: (HTTP 201)

json
{
  "version": "2.0.0",
  "timestamp": 1774885031464,
  "success": true,
  "code": "2001",
  "message": "Created",
  "data": {
    "bizId": "fhOnkyZeZSqZ00HI",
    "workspaceBizId": "XN6e38nLOpxOWUT9",
    "roleName": "DocVerify Test Role 1774885031458",
    "roleType": {
      "code": "CUSTOM",
      "value": 10010902,
      "label": "Custom",
      "description": "Custom defined role"
    },
    "description": "Created by doc-verify E2E test suite",
    "permissionCodes": [],
    "createdAt": "2026-03-30T15:37:11.463475070Z",
    "updatedAt": "2026-03-30T15:37:11.463475070Z"
  }
}

Error Response: (HTTP 400)

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

POST /web/v1/partner/roles/delete ​

Execute roles delete.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Request Body:

json
{
  "roleId": "fhOnkyZeZSqZ00HI"
}

Success Response: (HTTP 204)

json
null

Error Response: (HTTP 404)

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

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

Execute roles members role change.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
AuthorizationBearerJWT token
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Request Body:

json
{}

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 400)

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

POST /web/v1/partner/roles/permissions ​

Execute roles permissions.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
AuthorizationBearerJWT token
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Request Body:

json
{
  "roleId": "fhOnkyZeZSqZ00HI",
  "permissionCodes": [
    "wallet:read"
  ]
}

Success Response: (HTTP 200)

json
{
  "version": "2.0.0",
  "timestamp": 1774885031516,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "fhOnkyZeZSqZ00HI",
    "workspaceBizId": "XN6e38nLOpxOWUT9",
    "roleName": "DocVerify Updated Role 1774885031498",
    "roleType": {
      "code": "CUSTOM",
      "value": 10010902,
      "label": "Custom",
      "description": "Custom defined role"
    },
    "description": "Updated by doc-verify E2E test suite",
    "permissionCodes": [
      "wallet:read"
    ],
    "createdAt": "2026-03-30T15:37:11.463475Z",
    "updatedAt": "2026-03-30T15:37:11.503990Z"
  }
}

Error Response: (HTTP 400)

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

POST /web/v1/partner/roles/update ​

Execute roles update.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
AuthorizationBearerJWT token
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Request Body:

json
{
  "roleId": "fhOnkyZeZSqZ00HI",
  "roleName": "DocVerify Updated Role 1774885031498",
  "description": "Updated by doc-verify E2E test suite"
}

Success Response: (HTTP 200)

json
{
  "version": "2.0.0",
  "timestamp": 1774885031505,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "bizId": "fhOnkyZeZSqZ00HI",
    "workspaceBizId": "XN6e38nLOpxOWUT9",
    "roleName": "DocVerify Updated Role 1774885031498",
    "roleType": {
      "code": "CUSTOM",
      "value": 10010902,
      "label": "Custom",
      "description": "Custom defined role"
    },
    "description": "Updated by doc-verify E2E test suite",
    "permissionCodes": [],
    "createdAt": "2026-03-30T15:37:11.463475Z",
    "updatedAt": "2026-03-30T15:37:11.503990138Z"
  }
}

Error Response: (HTTP 400)

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

Invitations ​

GET /web/v1/partner/invitations ​

Retrieve invitations.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: (HTTP 200)

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

Error Response: (HTTP 401)

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

POST /web/v1/partner/invitations ​

Execute invitations.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Request Body:

json
{}

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 400)

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

POST /web/v1/partner/invitations/cancel ​

Execute invitations cancel.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Request Body:

json
{}

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 400)

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

Referral Codes ​

GET /web/v1/partner/referral-codes/mine ​

Retrieve referral codes mine.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: (HTTP 200)

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

Error Response: (HTTP 401)

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

POST /web/v1/partner/referral-codes ​

Execute referral codes.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Request Body:

json
{}

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 400)

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

POST /web/v1/partner/referral-codes/activate ​

Execute referral codes activate.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Request Body:

json
{
  "bizId": "non-existent-referral-code-id"
}

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 404)

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

POST /web/v1/partner/referral-codes/deactivate ​

Execute referral codes deactivate.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Request Body:

json
{
  "bizId": "non-existent-referral-code-id"
}

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 404)

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

POST /web/v1/partner/referral-codes/update ​

Execute referral codes update.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Request Body:

json
{
  "bizId": "non-existent-referral-code-id",
  "extraData": "updated data"
}

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 404)

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

Referrals ​

GET /web/v1/partner/referrals/mine/count ​

Retrieve referrals mine count.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: (HTTP 200)

json
{
  "version": "2.0.0",
  "timestamp": 1774885034152,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": 0
}

Error Response: (HTTP 401)

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

POST /web/v1/partner/referrals/mine/query ​

Execute referrals mine query.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Request Body:

json
{
  "page": 0,
  "size": 10
}

Success Response: (HTTP 200)

json
{
  "version": "2.0.0",
  "timestamp": 1774885034136,
  "success": true,
  "code": "2000",
  "message": "Success",
  "data": {
    "items": [],
    "total": 0,
    "page": 0,
    "size": 10
  }
}

Error Response: (HTTP 401)

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

Wallet ​

GET /web/v1/partner/wallets ​

Retrieve wallets.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: (HTTP 200)

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

Error Response: (HTTP 401)

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

GET /web/v1/partner/wallets/{walletBizId} ​

Retrieve wallets by ID.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
AuthorizationBearerJWT token
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Success Response: (HTTP 404)

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

Error Response: (HTTP 404)

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

GET /web/v1/partner/wallets/{walletBizId}/balance ​

Retrieve wallets by ID balance.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
AuthorizationBearerJWT token
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Success Response: (HTTP 404)

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

Error Response: (HTTP 404)

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

GET /web/v1/partner/wallets/{walletBizId}/flows ​

Retrieve wallets by ID flows.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: (HTTP 404)

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

Error Response: (HTTP 401)

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

Recharges ​

GET /web/v1/partner/recharges ​

Retrieve recharges.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: (HTTP 200)

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

GET /web/v1/partner/recharges/{bizId} ​

Retrieve recharges by ID.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
AuthorizationBearerJWT token
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 404)

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

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

Retrieve recharges available channels.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: (HTTP 200)

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

Error Response: (HTTP 401)

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

POST /web/v1/partner/recharges ​

Execute recharges.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Request Body:

json
{}

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 400)

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

POST /web/v1/partner/recharges/{bizId}/cancel ​

Execute recharges by ID cancel.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
AuthorizationBearerJWT token
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Request Body:

json
{
  "cancelReason": "Doc verification test cancel"
}

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 404)

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

POST /web/v1/partner/recharges/{bizId}/proof ​

Execute recharges by ID proof.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
AuthorizationBearerJWT token
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Request Body:

json
{
  "fileBizId": "some-file-biz-id"
}

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 404)

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

POST /web/v1/partner/recharges/quote ​

Execute recharges quote.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
AuthorizationBearerJWT token
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Request Body:

json
{
  "channelBizId": "doc-verify-channel-id",
  "amount": 100
}

Success Response: (HTTP 404)

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

Error Response: (HTTP 400)

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

Withdrawals ​

GET /web/v1/partner/withdrawals ​

Retrieve withdrawals.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: (HTTP 200)

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

GET /web/v1/partner/withdrawals/{bizId} ​

Retrieve withdrawals by ID.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
AuthorizationBearerJWT token
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 404)

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

POST /web/v1/partner/withdrawals ​

Execute withdrawals.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Request Body:

json
{}

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 400)

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

POST /web/v1/partner/withdrawals/{bizId}/cancel ​

Execute withdrawals by ID cancel.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
AuthorizationBearerJWT token
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 404)

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

Withdrawal Channels ​

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

Retrieve withdrawal channels.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: (HTTP 200)

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

Error Response: (HTTP 401)

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

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

Execute withdrawal channels.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Request Body:

json
{}

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 400)

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

Exchanges ​

GET /web/v1/partner/exchanges ​

Retrieve exchanges.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: (HTTP 200)

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

GET /web/v1/partner/exchanges/{bizId} ​

Retrieve exchanges by ID.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 404)

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

POST /web/v1/partner/exchanges ​

Execute exchanges.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Request Body:

json
{}

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 400)

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

POST /web/v1/partner/exchanges/quote ​

Execute exchanges quote.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Request Body:

json
{}

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 400)

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

Transfers ​

GET /web/v1/partner/transfers/query/orders ​

Retrieve transfers query orders.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: (HTTP 200)

json
{
  "version": "2.0.0",
  "timestamp": 1774885032986,
  "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 500)

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

GET /web/v1/partner/transfers/query/orders/{transferBizId} ​

Retrieve transfers query orders by ID.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 404)

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

GET /web/v1/partner/transfers/query/orders/{transferBizId}/completed ​

Retrieve transfers query orders by ID completed.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
AuthorizationBearerJWT token
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Success Response: (HTTP 200)

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

POST /web/v1/partner/transfers/command/create ​

Execute transfers command create.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Request Body:

json
{}

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 400)

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

Export ​

GET /web/v1/partner/exports ​

Retrieve exports.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: (HTTP 200)

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

GET /web/v1/partner/exports/{bizId} ​

Retrieve exports by ID.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 404)

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

GET /web/v1/partner/exports/{bizId}/download ​

Retrieve exports by ID download.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 404)

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

POST /web/v1/partner/exports ​

Execute exports.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Request Body:

json
{}

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 400)

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

File ​

GET /web/v1/partner/files/{bizId} ​

Retrieve files by ID.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 404)

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

GET /web/v1/partner/files/{bizId}/download ​

Retrieve files by ID download.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 404)

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

POST /web/v1/partner/files/upload ​

Execute files upload.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Workspace-IdWorkspace ID
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Optional Headers:

HeaderValueDescription
AuthorizationBearerJWT token

Request Body:

json
{}

Success Response: No successful E2E fixture captured for this endpoint.

Error Response: (HTTP 401)

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

Constants ​

GET /web/v1/partner/constants/countries ​

Retrieve constants countries.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Success Response: (HTTP 200)

json
{
  "version": "2.0.0",
  "timestamp": 1774885054258,
  "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/partner/constants/timezones ​

Retrieve constants timezones.

Required Headers:

HeaderValueDescription
X-PORTAL-ACCESS-CODEpac_xxxPortal access code
X-Request-IdUnique request ID
X-Client-HashClient fingerprint
X-Forwarded-ProtohttpsProtocol
CF-Connecting-IPClient IP
Cf-RayCloudflare ray ID
cf-ipcountryClient country
X-LOCALELocale
Content-Typeapplication/jsonContent type
Acceptapplication/jsonAccepted response MIME type
Accept-Languageen-US,en;q=0.9Preferred response language
User-Agentslaunchx-doc-verify/1.0Client user agent

Success Response: (HTTP 200)

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

SlaunchX Internal Documentation

Copyright © 2026 SlaunchX