> ## Documentation Index > Fetch the complete documentation index at: https://docs.testnet.dev.adipredictstreet.com/llms.txt > Use this file to discover all available pages before exploring further. # Initiate a withdrawal > Submits a USDC withdrawal request signed by the user's EOA. The backend co-signs after compliance review. Funds movement on-chain requires BOTH the user signature in `userSig` and the backend co-signature — neither party can move funds alone. Rate-limited to 5 req/min per wallet. ## OpenAPI ````yaml /api-reference/openapi.json post /api/withdrawals/request openapi: 3.1.0 info: title: PredictStreet core-api description: >- Client-facing HTTP gateway for the PredictStreet prediction-market platform. This spec is hand-written against the NestJS controllers and DTOs in core-api/src/modules/. For the source-of-truth live spec, run `./scripts/pull-openapi.sh` against a running core-api (NestJS exposes it at /api/docs-json). **Partner kinds.** Every authenticated endpoint resolves a request's *effective wallet* from the partner row. `single_wallet` partners bind to one `associatedWallet` set at creation. `multi_wallet` partners declare the actor on every request via an `X-User-Wallet: 0x<40-hex>` header. See the [Partner kinds](/auth/api-keys#partner-kinds) doc for the full contract. version: '2026-06-16' contact: name: PredictStreet partners email: partners@predictstreet.com servers: - url: https://core.api.dev.predictstreet.sde.adifoundation.ai description: Testnet (partner integrator API — final domain TBD) security: [] tags: - name: Deposits description: >- Gasless USDC deposit relay - submit a signed EIP-2612 permit and the platform broadcasts the on-chain deposit for you (no gas). - name: Events description: >- Polymarket-style event grouping with football metadata (group, stage, teams, tags). - name: Tags description: Curated tag taxonomy used to filter events. - name: Markets description: 'Public market data: list, detail, orderbook, trades, OHLC.' - name: Orders description: >- Signed-order place / cancel / read. Requires `X-Api-Key` with `orders:read` / `orders:write` scope; every write additionally requires an EIP-712 signature over the order. - name: Portfolio description: >- Balances, positions, trades, fees, vault info for the key's `associatedWallet`. Requires `X-Api-Key` with `portfolio:read` scope. - name: Matches description: >- admin.matches aggregate — groups several events into one fixture/card (1X2 + first-scorer + over-under under one matchup). - name: Vault description: >- Backend co-signatures for ERC-1155 split / merge, and recovery for off-chain locks when the corresponding chain tx never confirmed. Requires `X-Api-Key` with `vault:write` scope plus an EIP-712 signature over the operation. - name: Leaderboard description: Public ranked leaderboard across PnL / volume buckets. - name: Search description: Global search across users, events, and matches. - name: Withdrawal Security description: >- Self-service withdrawal 2FA (TOTP) and withdrawal-address whitelist. Same endpoints serve the frontend (Privy JWT) and API-key integrators. Mutations need `vault:write`, reads `portfolio:read`. Both are opt-in per wallet and only gate withdrawals once the platform enables withdrawal-security enforcement. paths: /api/withdrawals/request: post: tags: - Withdrawals summary: Initiate a withdrawal description: >- Submits a USDC withdrawal request signed by the user's EOA. The backend co-signs after compliance review. Funds movement on-chain requires BOTH the user signature in `userSig` and the backend co-signature — neither party can move funds alone. Rate-limited to 5 req/min per wallet. parameters: - $ref: '#/components/parameters/UserWalletHeader' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WithdrawRequestBody' responses: '200': description: OK — accepted into a routing state. Inspect `status` to know which. content: application/json: schema: $ref: '#/components/schemas/WithdrawRequestResponse' '403': description: >- Withdrawal-security gate rejected the request (only when the platform enforces withdrawal security). `code` ∈ `withdrawal_address_not_whitelisted`, `totp_required`, `totp_not_configured`, `totp_invalid`. See [Withdrawal 2FA](/concepts/withdrawals/two-factor) and [Address whitelist](/concepts/withdrawals/address-whitelist). content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Rate-limited (5 per minute per wallet). content: application/json: schema: $ref: '#/components/schemas/Error' security: - ApiKeyAuth: - vault:write components: parameters: UserWalletHeader: name: X-User-Wallet in: header required: false description: >- **Required for `multi_wallet` partners on every authenticated request; ignored for `single_wallet`.** Declares the acting end-user wallet for this request — drives KYC checks, balances/positions/orders attribution, rate-limit buckets, and audit. Lower-cased server-side. Missing on a multi_wallet key → 401 `api_key_user_wallet_required`; malformed → 401 `api_key_user_wallet_invalid`. The on-chain `CTFExchange`/`Vault` contracts still verify EIP-712 signer ↔ vault binding, so loosening API-layer attribution is safe by construction. schema: $ref: '#/components/schemas/EthereumAddress' example: '0x1234567890abcdef1234567890abcdef12345678' schemas: WithdrawRequestBody: type: object required: - amount - destination - salt - expiry - userSig properties: totpCode: type: string description: >- Withdrawal 2FA code. Required when the wallet has 2FA active and the platform enforces withdrawal security — else 403 `totp_required`. A 6-digit TOTP or a 16-hex backup code; single-use. Omit when 2FA is not configured. See [Withdrawal 2FA](/concepts/withdrawals/two-factor). example: '123456' amount: $ref: '#/components/schemas/DecimalString' description: USDC amount in human-readable decimal (NOT wei). example: '125.50' destination: type: string description: >- Destination EOA. must match a prior cleared deposit source OR be ≥ high-value review threshold (default 5000 USDC) to route through compliance review. Use `GET /api/me/withdrawals/deposit-sources` to surface the allowlist before signing. salt: type: string description: Per-user unique uint256 salt (decimal string). expiry: type: integer minimum: 0 example: 1729511712 description: EIP-712 expiry, Unix seconds. userSig: type: string description: >- EIP-712 signature over `{ token, amount, destination, salt, deadline }` against the user's vault EIP-712 domain. See [Withdrawals EIP-712](/concepts/withdrawals/eip712). WithdrawRequestResponse: type: object required: - status description: >- Routing outcome. Lowercase values (`rejected`, `mlro_review`) come from the gateway when it short-circuits before reaching the exchange-service hop. Uppercase values mirror the underlying record's `status` (the row landed in DB). properties: status: type: string enum: - PENDING - MLRO_REVIEW - CO_SIGNED - SUBMITTED - CONFIRMED - rejected - mlro_review id: type: string format: uuid description: Created withdrawal id when `status` is uppercase (record exists). code: type: string description: >- Machine-readable rejection code (e.g. `aml_block`, `destination_banned`). reason: type: string description: Human-readable rejection reason. Error: type: object required: - code properties: code: type: string description: >- Machine-readable code (e.g. `insufficient_funds`, `market_not_open`, `rate_limited`). message: type: string details: type: object additionalProperties: true EthereumAddress: type: string pattern: ^0x[a-fA-F0-9]{40}$ example: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb3' DecimalString: type: string description: >- Decimal number encoded as a string to preserve precision (e.g. `'100.5'`). securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-Api-Key description: >- Partner / integrator key — format `ps_live__`. Issued by PredictStreet ops via the admin panel; never self-service. Never ship to a browser. `multi_wallet` partners must additionally send `X-User-Wallet: 0x<40-hex>` on every authenticated request to declare the acting wallet. See the [API keys guide](/auth/api-keys) for scope taxonomy, partner kinds, rate limits, and rotation procedure. ````