> For the complete documentation index, see [llms.txt](https://docs.delos.financial/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.delos.financial/batchservice/get-example-manifest.md).

# Get Example Manifest

Returns a ready-to-fill `manifest.json` template generated from the batch's frozen schema. It is the fastest way to build a valid manifest: replace the placeholders with real values and file paths, remove optional parts you do not need, and save the result as `manifest.json` in the prefix root.

The template contains:

* one row per customer type selected for the batch;
* every profile field, with a `"<required>"` or `"<optional>"` placeholder;
* one document per document group;
* every unconditional questionnaire question, in the answer shape its type takes (`value`, `values` or `files`);
* for companies, one associated party per required role.

The same document is written to `example_manifest.json` in the batch prefix when the batch is created. The platform never reads the example as data.

**Endpoint**

`GET /v2/compliance/batch/{batch_id}/example-manifest`

**Link**

<https://partner.sandbox.delos.financial/openapi/v2.html#/operations/BatchService_GetExampleManifest>

**Request**

**Path Parameters**

| Parameter      | Type     | Description                        | Required | Example                                  |
| -------------- | -------- | ---------------------------------- | -------- | ---------------------------------------- |
| **`batch_id`** | `string` | Batch ID returned by Create Batch. | Yes      | `"01a0af8b-831f-7dbe-8eaf-459f81998958"` |

**Headers**

| Key             | Value              | Required |
| --------------- | ------------------ | -------- |
| `Authorization` | `<JWT>`            | Yes      |
| `Accept`        | `application/json` | Yes      |

**Response (200 OK)**

A JSON object with `schema_version` and `items`, placeholders in place of values. The row structure is described in Bulk Client Import → Manifest format.

**Example Response (fragment):**

```json
{
  "schema_version": "string",
  "items": [
    {
      "row_key": "<required>",
      "external_customer_id": "<optional>",
      "type": "individual",
      "fields": {
        "firstName": "<required>",
        "lastName": "<required>",
        "email": "<required>",
        "phone": "<required>"
      },
      "documents": [
        { "type": "PASSPORT", "file": "<required>" }
      ],
      "questionnaire": {
        "sections": {
          "sofandsow": {
            "items": {
              "sof": { "value": "<required>" }
            }
          }
        }
      }
    }
  ]
}
```

The fragment above is illustrative. Field ids, document types and questionnaire ids depend on your batch's schema — always use the template returned for your batch.

***

**Examples**

**Request**

```bash
curl --request GET \
  --url <https://partner.sandbox.delos.financial/v2/compliance/batch/01a0af8b-831f-7dbe-8eaf-459f81998958/example-manifest> \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <JWT>'
```

***

**Error Responses**

Errors are returned as `{"code", "message", "details"}`, where `code` is a gRPC status code. Use the HTTP status for error handling.

**Batch Not Found (404)** — the batch does not exist or belongs to another partner:

```json
{ "code": 5, "message": "batch not found", "details": [] }
```

**Authorization fail (401)**:

```json
{ "code": 16, "message": "Unauthorized", "details": [] }
```

***

**Notes**

* **Placeholders must be replaced**: a manifest that still contains `"<required>"` values fails validation for those rows.
* **Two-sided documents**: the template also shows the `FRONT_SIDE` / `BACK_SIDE` pair for identity documents that have two sides.
* **Conditional questions**: questions that appear only after a specific answer are not in the template; check Get Batch Schema for them.
* **Same schema as validation**: the template is built from the same frozen snapshot the rows are validated against.


---

# 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://docs.delos.financial/batchservice/get-example-manifest.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.