Skip to main content
GET
Vault — Document Status
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

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.
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.
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 for their roles. Passing the presign document_id here returns no match.

Authorizations

X-API-KEY
string
header
required

Query Parameters

rms_document_ids
string
required

Comma-separated list of rms_document_id values (the rms_document_id returned by confirm — NOT the presign document_id). Max 100.

organization_id
string<uuid>

Organization ID (optional).

user_id
string<uuid>

User id (optional).

user_email
string<email>

User email (optional).

user_name
string

User name (optional).

Response

Per-document status

statuses
object[]