> ## Documentation Index
> Fetch the complete documentation index at: https://docs.linqalpha.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Vault — Document Status

> Returns the processing status for one or more vault documents. Poll after confirm until status is `Synced` (complete and searchable).

Returns the processing status for one or more vault documents. Poll this after `confirm` until `status` is `Synced` (complete and searchable), or to re-check documents later.

## Status values

| `status`         | Meaning                                        |
| ---------------- | ---------------------------------------------- |
| `Synced`         | Complete and **searchable** — poll until this. |
| `Syncing...`     | Still processing.                              |
| `Syncing Failed` | Processing failed.                             |

<Note>For link-swapped formats (audio, legacy Office), the status stays `Syncing...` until the converted/transcript artifact is ready — so **`Synced` always means usable**, with no separate readiness flag.</Note>

Each entry also returns `fail_code` — a deterministic terminal-failure code (e.g. `PASSWORD_PROTECTED`, `FILE_SIZE_EXCEEDED`, `CONVERSION_FAILED`) so you can branch on the reason instead of parsing the `status` text. It is `null` unless the document terminally failed.

```bash theme={null}
curl --request GET \
  --url 'https://api.linqalpha.com/v2/vault/status?rms_document_ids=eeb72343-...,3a0e9e69-...' \
  --header 'X-API-KEY: <api-key>'
```

<Note>
  `rms_document_ids` is a comma-separated list of **`rms_document_id`** values (the `rms_document_id` returned by `confirm`), max 100.

  **Use `rms_document_id`, not the presign `document_id`.** The two are different identifiers — see [Confirm Upload](/api-reference/vault/confirm) for their roles. Passing the presign `document_id` here returns no match.
</Note>


## OpenAPI

````yaml GET /v2/vault/status
openapi: 3.0.1
info:
  title: LinqAlpha API
  description: >-
    Linq helps finance professionals make informed decisions using
    Retrieval-Augmented Generation (RAG)-enhanced answers. By leveraging
    cutting-edge Large Language Models (LLM) and supplementary technology, Linq
    provides the most optimized responses based on your queries.
  version: 1.0.0
  license:
    name: MIT
servers:
  - url: https://api.linqalpha.com
security:
  - ApiKeyAuth: []
tags:
  - name: Search
    description: Search and generate responses
  - name: Data
    description: Data retrieval and mapping
  - name: Feedback
    description: Conversation feedback
  - name: RMS
    description: Research Management System
  - name: Source Management
    description: Source batch and file management
  - name: MCP
    description: >-
      LinqAlpha MCP — Financial data tools for AI assistants via Model Context
      Protocol
  - name: Connectors
    description: Customer Connectors — customer-owned MCP connector management
  - name: Briefing
    description: Briefing Agent — automated market briefings with scheduling and delivery
  - name: Status
    description: Sync status — check organization, document, and container sync progress
paths:
  /v2/vault/status:
    get:
      tags:
        - Vault
      summary: Vault — Document Status
      description: >-
        Returns the processing status for one or more vault documents. Poll
        after confirm until status is `Synced` (complete and searchable).
      parameters:
        - name: rms_document_ids
          in: query
          required: true
          schema:
            type: string
          description: >-
            Comma-separated list of rms_document_id values (the rms_document_id
            returned by confirm — NOT the presign document_id). Max 100.
          example: >-
            eeb72343-d883-41a3-a58c-533184bbb9fd,3a0e9e69-191f-471a-94fd-97505c762ad3
        - name: organization_id
          in: query
          required: false
          schema:
            type: string
            format: uuid
          description: Organization ID (optional).
        - name: user_id
          in: query
          required: false
          schema:
            type: string
            format: uuid
          description: User id (optional).
        - name: user_email
          in: query
          required: false
          schema:
            type: string
            format: email
          description: User email (optional).
        - name: user_name
          in: query
          required: false
          schema:
            type: string
          description: User name (optional).
      responses:
        '200':
          description: Per-document status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VaultStatusResponse'
              example:
                statuses:
                  - rms_document_id: eeb72343-d883-41a3-a58c-533184bbb9fd
                    name: Q4_report.pdf
                    status: Synced
                    fail_code: null
        '400':
          description: Bad request — rms_document_ids required
        '401':
          description: Unauthorized — invalid or missing API key
components:
  schemas:
    VaultStatusResponse:
      type: object
      properties:
        statuses:
          type: array
          items:
            $ref: '#/components/schemas/VaultDocumentStatus'
    VaultDocumentStatus:
      type: object
      properties:
        rms_document_id:
          type: string
          nullable: true
        name:
          type: string
        status:
          type: string
          nullable: true
          description: >-
            Processing status. Poll until `Synced` (complete and searchable).
            See the status values table on this page.
        fail_code:
          type: string
          nullable: true
          description: >-
            Deterministic terminal-failure code (e.g. `PASSWORD_PROTECTED`,
            `FILE_SIZE_EXCEEDED`, `CONVERSION_FAILED`). Branch on this instead
            of parsing `status` text; `null` unless the document terminally
            failed.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY

````