> ## Documentation Index > Fetch the complete documentation index at: https://docs.docintell.com/llms.txt > Use this file to discover all available pages before exploring further. # Get document extraction status > Check the current extraction status of a document. Returns the status, timestamps, and processing details for a document's most recent extraction job. Args: document_id: UUID of the document to check status for. session_and_auth: Database session and auth context (injected). Returns: DocumentStatusResponse: Current status with timestamps and processing details. Raises: HTTPException 404: Document not found or not accessible by tenant. HTTPException 404: No extraction job exists for this document. Edge Cases: - **Tenant isolation**: RLS ensures tenants can only see their own documents. A 404 is returned for documents belonging to other tenants (not 403). - **Multiple jobs**: Returns the LATEST job by created_at timestamp. Use GET /documents/{id}/jobs to see all jobs for re-processed documents. - **Invalid UUID**: FastAPI validates UUID format; returns 422 if invalid. ## OpenAPI ````yaml openapi.json get /v1/documents/{document_id}/status openapi: 3.1.0 info: title: DocIntell API description: >- # DocIntell API **Turn Documents into Data. Keep the Source Safe.** Financial document intelligence platform that turns PDFs into queryable data while keeping source files secure and compliant. ## Features - **Document Ingestion**: Upload PDFs with SEC 17a-4 compliant immutable storage - **Schema Projection**: Query extracted data with custom schemas (not data dumps!) - **Multi-Schema Support**: Same document, multiple query patterns - **Webhook Delivery**: Async notifications on job completion - **Row-Level Security**: Multi-tenant isolation built-in ## Authentication All API endpoints (except `/health`, `/`, `/docs`, and `/redoc`) require API key authentication. Include your API key in the `Authorization` header: ``` Authorization: Bearer dk_live_ ``` Test keys start with `dk_test_`, production keys with `dk_live_`. ## Rate Limiting Per-tenant rate limits: - **Document ingestion**: 100 documents/hour - **Projection queries**: 1,000 requests/hour - **Schema operations**: 10 creates/hour Rate limit info is returned in response headers: - `X-RateLimit-Limit`: Maximum requests allowed - `X-RateLimit-Remaining`: Remaining requests in window - `X-RateLimit-Reset`: Unix timestamp when limit resets ## Error Handling All errors follow RFC 7807 Problem Details format: ```json { "error": "error_code", "message": "Human-readable description", "details": {} } ``` Common error codes: - `unauthorized` (401): Missing or invalid API key - `rate_limit_exceeded` (429): Too many requests - `invalid_file_type` (400): Only PDFs supported - `file_too_large` (413): File exceeds size limit (default 100MB, configurable via MAX_UPLOAD_SIZE_MB) - `job_not_found` (404): Job ID doesn't exist or doesn't belong to tenant ## Getting Started 1. Obtain API key from dashboard 2. Upload PDF: `POST /v1/documents` 3. Poll status: `GET /v1/documents/{document_id}/status` 4. Query results: `POST /v1/documents/{document_id}/project` Full documentation: [https://docs.docintel.com](https://docs.docintel.com) contact: name: DocIntell Support url: https://docintel.com/support email: support@docintel.com license: name: Proprietary url: https://docintel.com/terms version: 0.1.0 servers: - url: http://localhost:8000 description: Local development - url: https://api.docintell.com description: Production API - url: https://api-staging.docintell.com description: Staging environment security: - bearerAuth: [] tags: - name: health description: Health check operations. Verify service and dependency connectivity. x-mint-tag-group: System - name: api_keys description: API key management operations. Create, list, and revoke API keys. x-mint-tag-group: Management - name: documents description: Document ingestion operations. Upload PDFs for extraction. x-mint-tag-group: Core - name: jobs description: >- Job status and query operations. Check extraction status and query results. x-mint-tag-group: Core - name: document-types description: >- Document type schemas. List and retrieve extraction schema definitions for financial document types. - name: webhooks description: >- Webhook configuration management. Create, update, and manage webhook endpoints for job completion notifications. x-mint-tag-group: Integrations - name: stats description: Analytics and metrics endpoints. Get document, job, and schema statistics. - name: views description: >- View management for consumption layer. Define field subsets for querying extraction data. paths: /v1/documents/{document_id}/status: get: tags: - jobs summary: Get document extraction status description: |- Check the current extraction status of a document. Returns the status, timestamps, and processing details for a document's most recent extraction job. Args: document_id: UUID of the document to check status for. session_and_auth: Database session and auth context (injected). Returns: DocumentStatusResponse: Current status with timestamps and processing details. Raises: HTTPException 404: Document not found or not accessible by tenant. HTTPException 404: No extraction job exists for this document. Edge Cases: - **Tenant isolation**: RLS ensures tenants can only see their own documents. A 404 is returned for documents belonging to other tenants (not 403). - **Multiple jobs**: Returns the LATEST job by created_at timestamp. Use GET /documents/{id}/jobs to see all jobs for re-processed documents. - **Invalid UUID**: FastAPI validates UUID format; returns 422 if invalid. operationId: get_document_status_v1_documents__document_id__status_get parameters: - name: document_id in: path required: true schema: type: string format: uuid description: UUID of the document title: Document Id description: UUID of the document responses: '200': description: Current extraction status with timestamps and processing details content: application/json: schema: $ref: '#/components/schemas/DocumentStatusResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: DocumentStatusResponse: properties: job_id: type: string format: uuid title: Job Id description: Unique identifier for the ingestion job status: type: string enum: - pending - processing - completed - failed title: Status description: Current job status vault_uri: type: string title: Vault Uri description: GCS path to the document in Cold Vault created_at: type: string format: date-time title: Created At description: Job creation timestamp (ISO 8601) processing_started_at: anyOf: - type: string format: date-time - type: 'null' title: Processing Started At description: Processing start timestamp (ISO 8601, null if not started) processing_completed_at: anyOf: - type: string format: date-time - type: 'null' title: Processing Completed At description: Processing completion timestamp (ISO 8601, null if not completed) processing_time_seconds: anyOf: - type: number - type: 'null' title: Processing Time Seconds description: Total processing duration in seconds (null if not completed) page_count: anyOf: - type: integer - type: 'null' title: Page Count description: Number of pages in the document (null if not processed) error_message: anyOf: - type: string - type: 'null' title: Error Message description: Error details (only present if status is 'failed') type: object required: - job_id - status - vault_uri - created_at title: DocumentStatusResponse description: Response for job status queries (GET /v1/documents/{job_id}). examples: - completed_at: '2025-11-22T18:30:45Z' created_at: '2025-11-22T18:30:00Z' job_id: 550e8400-e29b-41d4-a716-446655440000 processing_time_seconds: 45 status: completed vault_uri: gs://docintel-vault-prod/tenant-123/2025/550e8400.pdf HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key description: 'API Key authentication. Format: dk_test_ or dk_live_' ````