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):

{
  "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

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:

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

Authorization fail (401):

{ "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.