> For the complete documentation index, see [llms.txt](https://detected.gitbook.io/detected-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://detected.gitbook.io/detected-docs/api-overview/webhooks/document-webhook-spec.md).

# Document Webhook Spec

Used specifically for events related to document workflow and processing.

## Webhook Payload

The payload of the web hook provides the following information in JSON format:

| Attribute   | Description                                                                                                       |
| ----------- | ----------------------------------------------------------------------------------------------------------------- |
| id          | the unique internal reference of the event                                                                        |
| profile\_id | The unique reference to the profile                                                                               |
| status      | The overall status of the processing                                                                              |
| updated\_at | The date/time of when the profile was last updated                                                                |
| statuses    | The statuses of the actions performed as part of the document processing will be null if that action is disabled. |

## Triggers, Events & Status

| Trigger                                  | Event              | Status   |
| ---------------------------------------- | ------------------ | -------- |
| Document provided by API                 | document.processed | Pending  |
| Processing triggered via case management | document.processed | Pending  |
| Documents submitted on a profile         | document.processed | Pending  |
| Single processing step completed         | document.processed | Pending  |
| All processing steps complete            | document.complete  | Complete |

## Examples

### Document provided by API

```json
{
  "event": "document.processed",
  "timestamp": "2026-09-14T13:06:50.870197Z",
  "data": {
    "id": 14527,
    "profile_id": "ead6dcb3-9e8f-42a6-aec8-481dabc7e768",
    "status": "pending",
    "statuses": {
      "translate": "pending",
      "ocr": "pending",
      "fraud_check": null
    }
  }
}
```

### Single processing step completed

```json
{
  "event": "document.processed",
  "timestamp": "2026-09-14T13:07:23.637435Z",
  "data": {
    "id": 14527,
    "profile_id": "ead6dcb3-9e8f-42a6-aec8-481dabc7e768",
    "status": "pending",
    "statuses": {
      "translate": "pending",
      "ocr": "pending",
      "fraud_check": "complete"
    }
  }
}
```

### Document processing complete

```json
{
  "event": "document.complete",
  "timestamp": "2026-09-14T13:08:05.328832Z",
  "data": {
    "id": 14527,
    "profile_id": "ead6dcb3-9e8f-42a6-aec8-481dabc7e768",
    "status": "complete",
    "statuses": {
      "translate": "complete",
      "ocr": "complete",
      "fraud_check": "complete"
    }
  }
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://detected.gitbook.io/detected-docs/api-overview/webhooks/document-webhook-spec.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.