> ## Documentation Index > Fetch the complete documentation index at: https://docs.bluumfinance.com/llms.txt > Use this file to discover all available pages before exploring further. # List documents (flat resource) ## OpenAPI ````yaml /api-reference/openapi.yaml get /documents openapi: 3.0.0 info: title: Bluum Finance Investment API version: 1.0.0 description: > The Bluum Finance API provides embeddable investment experiences, allowing fintech partners to manage investor accounts, facilitate trading, handle document uploads, and manage wallet operations. ### Response conventions Every resource response carries a small, consistent set of envelope keys followed by domain fields: ```json { "id": "_", "object": "", "created": , "livemode": , "metadata": { ... }, ... domain fields ... } ``` List endpoints return: ```json { "object": "list", "url": "/v1/", "has_more": false, "data": [ ... ] } ``` Errors are wrapped in: ```json { "error": { "type": "invalid_request_error", "code": "BLUM-400-001", "message": "...", "param": "tax_id" } } ``` See `ResourceEnvelope`, `ListEnvelope`, and `ErrorEnvelope` in `shared-schemas.yaml` for the full schemas. ### Product entitlements Core investing (accounts, funding, trading, positions, documents, webhooks) is available to every tenant. Three surfaces are add-on products that must be enabled for your tenant before use: - **Market Data** — `/v1/market-data/*` - **Cash Management** — `/v1/cash-management/*` Calling a disabled product returns HTTP `403` with the legacy `{ "status": "error", "code": "PRODUCT_NOT_ENABLED", "message": "..." }` body (not the standard error envelope). Contact your Bluum account manager to enable a product. ### Field naming - snake_case throughout (no camelCase) - `email` / `phone` (not `email_address` / `phone_number`) - `first_name` / `middle_name` / `last_name` (not `given_name` / `family_name`) - `address: { street: [string], unit?, city, state?, postal_code?, country }` (the `street` array form preserves multi-line addresses; ISO 3166-1 alpha-2 country code on `address.country` and on the top-level `country_of_*` fields) - `quantity` (not `qty`) - Status enums are lowercase Bluum-native vocabulary (e.g. `pending` / `filled` / `cancelled` / `failed`) Regulatory vocabulary (CAIS / FINRA / IRS / FATF) is preserved verbatim (e.g. `tax_id_type`, `country_of_tax_residence`, `is_politically_exposed`, `funding_source`). ### Terminology The investor resource lives at `/v1/investors`. Path parameter is `investor_id`. ### Asset classification Assets carry a canonical `(class, country)` pair: - `class`: `equity` | `etf` | `bond` | `bill` | `note` | `mutual_fund` | `derivative` | `cryptocurrency` | `commodity` | `real_estate` | `cash` - `country`: ISO 3166-1 alpha-2, lower-case (`us`, `ng`, …). Null for country-agnostic instruments (most crypto). ### Fixed income (bonds) Bond orders use the same `POST /v1/investors/{investor_id}/orders` endpoint as equities, with bond-specific semantics: - `quantity` carries **face value** (e.g. `"10000"` for $10k face), and must be a multiple of the bond's `min_increment`. - `limit_price` is quoted as **% of par** (e.g. `"99.875"` = 99.875% of face value). - `settlement_date` is optional; defaults to T+1 for US treasuries and T+2 for corporates. - Bond quote responses (`/v1/market-data/assets/{symbol}/quote`) include a `bond` block with clean/dirty price, accrued interest, and yield to maturity. Bond trading must be explicitly enabled on the tenant before orders will route. Contact Bluum support to flip `fixedIncomeEnabled`. ### Authentication HTTP Basic Authentication. **API Key** is the username, **API Secret** is the password. Base64-encode `API_KEY:API_SECRET` and send in the `Authorization` header. servers: - url: https://api.bluumfinance.com/v1 description: Production Environment - url: https://sandbox.api.bluumfinance.com/v1 description: Sandbox/Testing Environment - url: https://service.bluumfinance.com/v1 description: Production Environment (legacy alias) - url: https://test-service.bluumfinance.com/v1 description: Sandbox/Testing Environment (legacy alias) security: - BluumApiKeyAuth: [] - BearerAuth: [] tags: - name: Investors description: Create and manage investor accounts, wallets, and transactions. - name: API Keys description: Mint, list, and revoke investor-scoped API keys for programmatic access. - name: Compliance description: Investor compliance workflows, KYC checks, and document submissions. - name: Transfers description: Deposit and withdrawal operations for investor wallets. - name: Funding Sources description: Connect and manage external funding sources (Plaid, bank accounts). - name: Trading description: Place, list, and cancel investor orders. - name: Positions description: View investor portfolio positions. - name: Assets description: Search and retrieve asset reference data. - name: Document Management description: Upload, list, and download documents. - name: Markets description: Market reference data, status, calendar, and halts. - name: Market Data description: Real-time quotes, snapshots, and historical bars (paywalled product). - name: Webhooks description: Register and manage webhook endpoints for event delivery. - name: Disclosures description: >- Partner-facing disclosure library (verbatim regulated copy, PDFs) + per-investor acceptance trail. - name: Cash Sweep description: >- High Yield Cash (HYC) / FDIC Bank Sweep enrollment, tier management, and interest reporting. - name: Cash Management description: >- Multi-currency, zero-day-liquidity yield on cash — programs, eligibility, enrollment, sweeps, withdrawals, earnings. paths: /documents: get: tags: - Document Management summary: List documents (flat resource) operationId: listDocumentsFlat parameters: - name: investor_id in: query required: false schema: type: string description: Filter to documents owned by an investor (prefixed `inv_…` id). - name: user_id in: query required: false schema: type: string description: Filter to documents owned by a user. - name: purpose in: query required: false schema: type: string enum: - KYC - KYB - EDD - TAX - FUNDING_VERIFICATION - AGREEMENT - ACCOUNT_STATEMENT - TRADE_CONFIRMATION - OTHER - name: status in: query required: false schema: type: string enum: - UPLOADED - PROCESSING - ACCEPTED - REJECTED - EXPIRED - name: document_type in: query required: false schema: type: string - name: limit in: query required: false schema: type: integer minimum: 1 maximum: 200 default: 50 - name: starting_after in: query required: false schema: type: string description: Cursor — `document_id` of the previous page's last item. responses: '200': description: Paginated list of documents content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/DocumentResponse' has_more: type: boolean '401': $ref: '#/components/responses/UnauthorizedError' components: schemas: DocumentResponse: description: | Document resource returned by `/v1/documents` endpoints. Uses the flat document shape: `document_id` is the public id, `owner_type` / `owner_id` are polymorphic ownership refs (INVESTOR / USER / TENANT). `purpose` indicates what the doc is for (KYC, KYB, EDD, TAX, FUNDING_VERIFICATION, AGREEMENT, OTHER). type: object required: - document_id - object - owner_type - owner_id - document_type - file_name - mime_type - status - uploaded_at properties: document_id: type: string example: doc_01j9x8m2k7qpzwv3t5r6y8n0ab object: type: string enum: - document owner_type: type: string enum: - tenant - investor - user owner_id: type: string description: UUID of the owning entity (raw, not prefix-encoded). purpose: type: string enum: - kyc - kyb - edd - tax - funding_verification - agreement - account_statement - trade_confirmation - other nullable: true document_type: type: string description: Free-form classifier (e.g. PASSPORT, BANK_STATEMENT, CIP_RESULT). example: id_verification file_name: type: string example: id-front.png mime_type: type: string example: image/png file_size: type: integer nullable: true status: type: string enum: - uploaded - processing - accepted - rejected - expired expires_at: type: string format: date-time nullable: true uploaded_at: type: string format: date-time metadata: type: object nullable: true additionalProperties: true ErrorEnvelope: type: object description: | Error envelope. The Bluum-specific `BLUM-XXX-XXX` code is carried in `error.code`; `error.type` is the broad category clients branch on. required: - error properties: error: type: object required: - type - code - message properties: type: type: string enum: - invalid_request_error - authentication_error - permission_error - not_found_error - conflict_error - idempotency_error - rate_limit_error - api_error example: invalid_request_error code: type: string description: The Bluum-specific error code. example: BLUM-400-001 message: type: string description: Developer-facing message. param: type: string description: Field path of the invalid input. example: tax_id doc_url: type: string format: uri example: https://docs.bluum.finance/errors/BLUM-400-001 request_log_url: type: string format: uri description: Deep link to the request log in the partner dashboard. responses: UnauthorizedError: description: Authentication information is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: type: authentication_error code: BLUM-401-001 message: Missing or invalid Authorization header. securitySchemes: BluumApiKeyAuth: type: http scheme: basic description: > HTTP Basic Authentication using the **API Key** as username and **API Secret** as password. BearerAuth: type: http scheme: bearer bearerFormat: JWT description: | JWT token from Clerk authentication ````