API reference

Retrieve document

Retrieve the current document resource. Poll this endpoint until a terminal status, or receive an optional callback as an untrusted wakeup hint and fetch here with authenticated credentials.

On this page

GET/v1/documents/{document_id}

Path parameters

document_idstringrequired

The doc_… identifier returned by create document.

Responses

200 - the document resource. Its shape is a discriminated union on status.
404 - unknown document for this account; tenant isolation never leaks existence across accounts.
410 - document_expired: the retained result passed its deadline and is gone.
429 - throttled; treat Retry-After as a minimum delay.

Shape by status

awaiting_upload, queued, processing - identity, policy, and processing metadata only. No data, no validation.
completed, needs_review - include the invoice.v1 data tree and validation checks, plus processing.result_expires_at.
failed - carries the public error; no usable result exists.

The data value validates against the standalone invoice.v1 JSON Schema. See the schema reference for field semantics.

Polling and retention

While queued or processing, responses may include a Retry-After header - treat it as a minimum delay. Terminal structured results are retained 7 days by default; persist what your workflow needs before processing.result_expires_at.

Retention and deletion details

[data-code-tabs-interactive] { display: none !important; }

cURLBash / Zsh syntax (macOS, Linux, or WSL).

curl --fail-with-body --no-location \
  https://api.temlavo.com/v1/documents/doc_9f3kc28d \
  -H "Authorization: Bearer inv_live_your_key"

TypeScript SDK

const document = await client.documents.get('doc_9f3kc28d');

// Or hold until a terminal status (respects Retry-After):
const terminal = await client.documents.wait('doc_9f3kc28d', {
  timeoutMs: 120_000,
});

TerminalBash / Zsh syntax (macOS, Linux, or WSL).

curl --fail-with-body --no-location \
  https://api.temlavo.com/v1/documents/doc_9f3kc28d \
  -H "Authorization: Bearer inv_live_your_key"

HTTP endpoint response

200 OK
{
  "id": "doc_9f3kc28d",
  "object": "document",
  "status": "completed",
  "document_type": "invoice",
  "schema_version": "invoice.v1",
  "policy": { "required_fields": [], "line_items": "advisory", "checks": { "duplicate_detection": true } },
  "data": { "…": "invoice.v1 structured result" },
  "validation": { "review_required": false, "checks": [] },
  "processing": { "result_expires_at": "2026-09-23T15:30:00.000Z" }
}