> This page is for API.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.spreadspace.app/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.spreadspace.app/_mcp/server.

# document.failed

POST 

Fires when a document is rejected, hits an unrecoverable extraction error, or is resolved as a duplicate of one already on the deal. `reason` carries the short code or message. `message`, when present, is a sentence you can show the uploader.

Reference: https://docs.spreadspace.app/api/api-reference/webhook-events/webhook-document-failed

## Request

### Headers

- `SpreadSpace-Signature` (string, required) — Signature over the exact request body: `t=<seconds since the Unix epoch>,v1=<lowercase hex HMAC-SHA256 of "{t}.{body}" keyed with your endpoint's signing secret>`. Verify it before trusting the body, and reject a `t` more than five minutes from your own clock. During a secret rotation both the new and the previous secret verify for 24 hours; each delivery is signed with exactly one.
- `SpreadSpace-Event-Id` (string, required) — The event id, identical to the body's `id`. Stable across retries and replays, and shared by every endpoint one event fans out to. Delivery is at-least-once, so dedupe on it.

### Payload

- `id` (string, required) — Event id: `evt_` plus 24 lowercase hex characters. Also sent as the `SpreadSpace-Event-Id` header. Stable across retries and replays, so dedupe on it.
- `type` (enum, required) — Always this event type on this body.
  - Allowed values: `document.failed`
- `created` (long, required) — Seconds since the Unix epoch at which the event was created server-side. Seconds, not milliseconds. Deliveries are not ordered; reconcile on this.
- `tenant_id` (string, required) — The workspace the event belongs to. Reject a delivery whose tenant does not match the endpoint you registered.
- `livemode` (boolean, required) — `true` for live activity, `false` for test mode (an `ss_test_` key or the sandbox simulator). Branch on it to route test deliveries to a staging handler.
- `data` (DocumentFailedPayload, required) — The `data` object on a `document.failed` delivery, sent when a document is rejected or hits an unrecoverable extraction error. `reason` is a short failure code or a human-readable message. Match it for equality against the codes you know and treat anything else as opaque; a richer machine-readable reason can be added later without changing the wire schema.

## Types

### DocumentFailedPayload

The `data` object on a `document.failed` delivery, sent when a document is rejected or hits an unrecoverable extraction error. `reason` is a short failure code or a human-readable message. Match it for equality against the codes you know and treat anything else as opaque; a richer machine-readable reason can be added later without changing the wire schema.

- `document_id` (string, required) — The extracted document.
- `job_id` (string, required) — The document package (job) the document was uploaded in.
- `borrower_id` (string, required) — The borrower that owns the loan.
- `loan_id` (string, required) — The loan the document belongs to.
- `reason` (string, required) — `unextractable` when the document could not be extracted, whatever the cause; `message` then carries a sentence you can show the uploader when there is one. A document resolved as a duplicate carries that resolution instead (`content_hash_duplicate`, `exact_duplicate`, `subset_superseded`). Those are not extraction errors: the content is already on the deal under the original document. Anything else is `extraction_error` or free text.
- `failed_at` (datetime, required) — Server-side wall-clock time the failure was recorded.
- `message` (string, optional, nullable) — A sentence you can show the uploader, present only when the failure has one, for example a bank statement that did not include all of its pages. `reason` is unchanged by it. Omitted otherwise.