Vault — Document Status
Analytics V2
Vault — Document Status
Returns the processing status for one or more vault documents. Poll after confirm until status is Synced (complete and searchable).
GET
Vault — Document Status
Returns the processing status for one or more vault documents. Poll this after
Each entry also returns
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.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
Query Parameters
Comma-separated list of rms_document_id values (the rms_document_id returned by confirm — NOT the presign document_id). Max 100.
Organization ID (optional).
User id (optional).
User email (optional).
User name (optional).
Response
Per-document status