> ## Documentation Index > Fetch the complete documentation index at: https://docs.sahlfinancial.com/llms.txt > Use this file to discover all available pages before exploring further. # List documents > **Who can call it:** Any signed-in member of the workspace. Newest first. Send `X-Sahl-Environment: sandbox` or `production` (or the `environment` query parameter) to choose the workspace. Without it, no environment filter is applied. `production` is refused with 403 `production_requires_paid_plan` when the subscription is cancelled or suspended. **Auth:** dashboard session (`Authorization: Bearer `). Not available with a partner API key. ## OpenAPI ````yaml /openapi-console.json get /v1/documents openapi: 3.1.0 info: title: Sahl Console API version: 0.1.0 description: >- **Used by the Sahl console. Not available with partner API keys. Contact Sahl if you need programmatic access.** These are the routes the Sahl console calls with a signed-in user's session. They are documented so that a developer or a workspace admin can see what the console does, with the real request and response models. They are **not** part of the [Partner API](/api-reference/introduction): an API key is refused here (401), there is no try-it, and the shapes can change with the console. Authentication: `Authorization: Bearer `, the JWT the console gets from `POST /v1/auth/login` (30 minutes; renewed with `POST /v1/auth/refresh`, refresh token valid 7 days). There is no cookie. The role of the user is read from the user's record on every call, not from the token. Every call is scoped to the workspace of the user. Common answers: 401 (no or bad session), 403 `Insufficient permissions` (role), 422 (validation), 429 (100 requests per minute and IP). Error bodies have the same three shapes as the Partner API: see [Errors](/errors). servers: - url: https://app.sahlfinancial.com/api description: Console host. Same host as the Partner API. security: - dashboardSession: [] tags: - name: Bank connections description: Simulated in the Sandbox; 409 `bank_connect_unavailable` elsewhere. - name: Cases description: Client files that group documents, a score and a decision. - name: Documents description: Upload, status, result and download. - name: Webhooks description: Manage the endpoints that receive events. - name: API keys description: Create, rotate and revoke the keys used with the Partner API. - name: Scoring policies description: Weights and thresholds of the credit score. - name: Flows description: Verification flows (graphs) and their simulation. paths: /v1/documents: get: tags: - Documents summary: List documents description: >- **Who can call it:** Any signed-in member of the workspace. Newest first. Send `X-Sahl-Environment: sandbox` or `production` (or the `environment` query parameter) to choose the workspace. Without it, no environment filter is applied. `production` is refused with 403 `production_requires_paid_plan` when the subscription is cancelled or suspended. **Auth:** dashboard session (`Authorization: Bearer `). Not available with a partner API key. operationId: listDocuments parameters: - name: page in: query required: false schema: type: integer minimum: 1 default: 1 title: Page - name: page_size in: query required: false schema: type: integer maximum: 100 minimum: 1 default: 20 title: Page Size - name: status in: query required: false schema: anyOf: - enum: - uploaded - queued - processing - completed - completed_with_warnings - failed - review_required type: string - type: 'null' title: Status - name: document_type in: query required: false schema: anyOf: - type: string - type: 'null' title: Document Type - name: search in: query required: false schema: anyOf: - type: string - type: 'null' title: Search - name: upload_source in: query required: false schema: anyOf: - type: array items: enum: - api - dashboard - webhook - batch - partner type: string - type: 'null' title: Upload Source - name: reference in: query required: false schema: anyOf: - type: string maxLength: 255 - type: 'null' title: Reference - name: created_from in: query required: false schema: anyOf: - type: string format: date - type: 'null' title: Created From - name: created_to in: query required: false schema: anyOf: - type: string format: date - type: 'null' title: Created To - name: environment in: query required: false schema: anyOf: - type: string - type: 'null' title: Environment - name: X-Sahl-Environment in: header required: false schema: anyOf: - type: string - type: 'null' title: X-Sahl-Environment responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DocumentListResponse' example: items: - id: a8f1c3e5-6b2d-4974-8e0a-1d5c7b9f3e26 tenant_id: 0b6f5a3e-7c1d-4e0a-9d2f-3a1c5e8b7f10 external_reference: null filename: payslip-test.pdf content_type: application/pdf file_size: 184320 upload_source: api document_type_hint: payslip document_type_detected: payslip document_type_final: null status: completed page_count: 1 checksum_sha256: 9f2c...redacted created_at: '2026-10-07T09:14:22Z' updated_at: '2026-10-07T09:14:22Z' total: 1 page: 1 page_size: 20 '401': description: No session, expired token, ended session or inactive account. content: application/json: schema: $ref: '#/components/schemas/Error' example: detail: Invalid or expired token '403': description: >- The role is not allowed, MFA enrolment is pending, or the environment is refused. content: application/json: schema: $ref: '#/components/schemas/Error' example: detail: Insufficient permissions '422': description: Validation error. content: application/json: schema: $ref: '#/components/schemas/Error' example: detail: - type: missing loc: - body - bank_code msg: Field required input: {} '429': description: >- More than 100 requests per minute from one IP address. The body has no `detail`. content: application/json: schema: $ref: '#/components/schemas/RateLimitError' example: code: rate_limit_exceeded message: Too many requests. Please slow down. headers: Retry-After: schema: type: integer description: Seconds to wait. components: schemas: DocumentListResponse: properties: items: items: $ref: '#/components/schemas/DocumentResponse' type: array total: type: integer page: type: integer page_size: type: integer type: object required: - items - total - page - page_size Error: type: object description: >- FastAPI error body. `detail` is a string, a list (422), or an object with `code` and `message` (extra keys possible). properties: detail: oneOf: - type: string - items: additionalProperties: true type: object type: array - type: object additionalProperties: true properties: code: type: string message: type: string required: - detail RateLimitError: type: object description: Top-level `code` and `message`, no `detail`. properties: code: type: string message: type: string required: - code - message DocumentResponse: properties: id: type: string format: uuid tenant_id: type: string format: uuid external_reference: anyOf: - type: string - type: 'null' filename: type: string content_type: type: string file_size: type: integer upload_source: type: string document_type_hint: anyOf: - type: string - type: 'null' document_type_detected: anyOf: - type: string - type: 'null' document_type_final: anyOf: - type: string - type: 'null' status: type: string page_count: anyOf: - type: integer - type: 'null' checksum_sha256: anyOf: - type: string - type: 'null' created_at: type: string format: date-time updated_at: type: string format: date-time type: object required: - id - tenant_id - external_reference - filename - content_type - file_size - upload_source - document_type_hint - document_type_detected - document_type_final - status - page_count - checksum_sha256 - created_at - updated_at securitySchemes: dashboardSession: type: http scheme: bearer bearerFormat: JWT description: >- The access token (JWT) of a signed-in console user, from `POST /v1/auth/login`. It lasts 30 minutes. It is not an API key: a partner API key is refused here. There is no cookie. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.