Templates
Lists all templates available to the API client: builtin templates
(identified by their stable key) and the client's custom templates
(identified by uuid). Use a template's id as template_id in
create_submission.
Authorization
bearerAuth Partner API key, sent as Authorization: Bearer <api key>.
In: header
Query Parameters
Maximum number of items to return. Values above 100 are clamped to 100.
1 <= value <= 10050Opaque pagination cursor from the previous page's next_cursor.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/templates"{ "data": [ { "id": "string", "key": "default_personal_real_estate_financing", "builtin": true, "display_name": "string", "is_default": true, "revision": 0, "archived": true, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "next_cursor": "string"}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}Creates a custom template, optionally with its full bundle of document requirements, check items, and data-field items in one request. Items reference catalog entries by id (builtin key or custom uuid); array order is display order.
Authorization
bearerAuth Partner API key, sent as Authorization: Bearer <api key>.
In: header
Request Body
application/json
The template and its optional item bundles.
TypeScript Definitions
Use the request body type in TypeScript.
Attributes for a new custom template, optionally with its full item bundle.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/templates" \ -H "Content-Type: application/json" \ -d '{ "display_name": "string" }'{ "id": "string", "key": "default_personal_real_estate_financing", "builtin": true, "display_name": "string", "is_default": true, "revision": 0, "archived": true, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "document_requirements": [ { "document_type_id": "string", "key": "abgeschlossenheit", "label": "string", "description": "string", "required": true, "allow_multiple_files": true } ], "check_items": [ { "check_id": "string", "key": "business_dd.company_legal_identification", "title": "string" } ], "data_field_items": [ { "data_field_id": "string", "key": "anrede", "display_name": "string", "required": true, "confidence_threshold": 0 } ]}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}Returns the template with its resolved bundle: the document requirements a submission will materialize as document slots, the checks an evaluation will execute, and the data fields it will extract.
Authorization
bearerAuth Partner API key, sent as Authorization: Bearer <api key>.
In: header
Path Parameters
The template's id — a builtin template key or a custom template uuid.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/templates/string"{ "id": "string", "key": "default_personal_real_estate_financing", "builtin": true, "display_name": "string", "is_default": true, "revision": 0, "archived": true, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "document_requirements": [ { "document_type_id": "string", "key": "abgeschlossenheit", "label": "string", "description": "string", "required": true, "allow_multiple_files": true } ], "check_items": [ { "check_id": "string", "key": "business_dd.company_legal_identification", "title": "string" } ], "data_field_items": [ { "data_field_id": "string", "key": "anrede", "display_name": "string", "required": true, "confidence_threshold": 0 } ]}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}Updates a custom template's own attributes (display_name, is_default).
Requires the current expected_revision; a mismatch fails with
409 revision_mismatch — re-read the template and retry. Builtin templates
cannot be updated (422 invalid_field); duplicate them instead. Changes
affect future submissions only.
Authorization
bearerAuth Partner API key, sent as Authorization: Bearer <api key>.
In: header
Path Parameters
The template's id — a builtin template key or a custom template uuid.
Request Body
application/json
The attributes to change and the expected revision.
TypeScript Definitions
Use the request body type in TypeScript.
Template attribute changes; omitted fields stay unchanged.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/v1/templates/string" \ -H "Content-Type: application/json" \ -d '{ "expected_revision": 0 }'{ "id": "string", "key": "default_personal_real_estate_financing", "builtin": true, "display_name": "string", "is_default": true, "revision": 0, "archived": true, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "document_requirements": [ { "document_type_id": "string", "key": "abgeschlossenheit", "label": "string", "description": "string", "required": true, "allow_multiple_files": true } ], "check_items": [ { "check_id": "string", "key": "business_dd.company_legal_identification", "title": "string" } ], "data_field_items": [ { "data_field_id": "string", "key": "anrede", "display_name": "string", "required": true, "confidence_threshold": 0 } ]}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}Archives a custom template: it disappears from listings and can no longer
create submissions; existing submissions keep their materialized snapshot
and remain fully usable. Archiving is not reversible via the API. Builtin
templates cannot be archived (422 invalid_field).
Authorization
bearerAuth Partner API key, sent as Authorization: Bearer <api key>.
In: header
Path Parameters
The template's id — a builtin template key or a custom template uuid.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/v1/templates/string"{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}Creates a custom template as a copy of the given template — the standard
way to customize a builtin template. The copy starts with the source's full
item bundle and is_default: false.
Authorization
bearerAuth Partner API key, sent as Authorization: Bearer <api key>.
In: header
Path Parameters
The template's id — a builtin template key or a custom template uuid.
Request Body
application/json
Optional attributes for the copy.
TypeScript Definitions
Use the request body type in TypeScript.
Optional attributes for a template copy.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/templates/string/duplicate" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "string", "key": "default_personal_real_estate_financing", "builtin": true, "display_name": "string", "is_default": true, "revision": 0, "archived": true, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "document_requirements": [ { "document_type_id": "string", "key": "abgeschlossenheit", "label": "string", "description": "string", "required": true, "allow_multiple_files": true } ], "check_items": [ { "check_id": "string", "key": "business_dd.company_legal_identification", "title": "string" } ], "data_field_items": [ { "data_field_id": "string", "key": "anrede", "display_name": "string", "required": true, "confidence_threshold": 0 } ]}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}Replaces the custom template's document requirement list as a whole; array
order is display order. Guarded by expected_revision
(409 revision_mismatch on mismatch). Affects future submissions only.
Authorization
bearerAuth Partner API key, sent as Authorization: Bearer <api key>.
In: header
Path Parameters
The template's id — a builtin template key or a custom template uuid.
Request Body
application/json
The full replacement list and the expected revision.
TypeScript Definitions
Use the request body type in TypeScript.
Full replacement of a template's document requirement list.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/v1/templates/string/document_requirements" \ -H "Content-Type: application/json" \ -d '{ "expected_revision": 0, "items": [ { "document_type_id": "string" } ] }'{ "id": "string", "key": "default_personal_real_estate_financing", "builtin": true, "display_name": "string", "is_default": true, "revision": 0, "archived": true, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "document_requirements": [ { "document_type_id": "string", "key": "abgeschlossenheit", "label": "string", "description": "string", "required": true, "allow_multiple_files": true } ], "check_items": [ { "check_id": "string", "key": "business_dd.company_legal_identification", "title": "string" } ], "data_field_items": [ { "data_field_id": "string", "key": "anrede", "display_name": "string", "required": true, "confidence_threshold": 0 } ]}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}Replaces the custom template's check list as a whole; array order is
display order. Guarded by expected_revision (409 revision_mismatch on
mismatch). Affects future submissions only.
Authorization
bearerAuth Partner API key, sent as Authorization: Bearer <api key>.
In: header
Path Parameters
The template's id — a builtin template key or a custom template uuid.
Request Body
application/json
The full replacement list and the expected revision.
TypeScript Definitions
Use the request body type in TypeScript.
Full replacement of a template's check list.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/v1/templates/string/check_items" \ -H "Content-Type: application/json" \ -d '{ "expected_revision": 0, "items": [ { "check_id": "string" } ] }'{ "id": "string", "key": "default_personal_real_estate_financing", "builtin": true, "display_name": "string", "is_default": true, "revision": 0, "archived": true, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "document_requirements": [ { "document_type_id": "string", "key": "abgeschlossenheit", "label": "string", "description": "string", "required": true, "allow_multiple_files": true } ], "check_items": [ { "check_id": "string", "key": "business_dd.company_legal_identification", "title": "string" } ], "data_field_items": [ { "data_field_id": "string", "key": "anrede", "display_name": "string", "required": true, "confidence_threshold": 0 } ]}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}Replaces the custom template's data-field list as a whole; array order is
display order. Guarded by expected_revision (409 revision_mismatch on
mismatch). Affects future submissions only.
Authorization
bearerAuth Partner API key, sent as Authorization: Bearer <api key>.
In: header
Path Parameters
The template's id — a builtin template key or a custom template uuid.
Request Body
application/json
The full replacement list and the expected revision.
TypeScript Definitions
Use the request body type in TypeScript.
Full replacement of a template's data-field list.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/v1/templates/string/data_field_items" \ -H "Content-Type: application/json" \ -d '{ "expected_revision": 0, "items": [ { "data_field_id": "string" } ] }'{ "id": "string", "key": "default_personal_real_estate_financing", "builtin": true, "display_name": "string", "is_default": true, "revision": 0, "archived": true, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "document_requirements": [ { "document_type_id": "string", "key": "abgeschlossenheit", "label": "string", "description": "string", "required": true, "allow_multiple_files": true } ], "check_items": [ { "check_id": "string", "key": "business_dd.company_legal_identification", "title": "string" } ], "data_field_items": [ { "data_field_id": "string", "key": "anrede", "display_name": "string", "required": true, "confidence_threshold": 0 } ]}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}{ "error": { "code": "invalid_field", "message": "external_submission_id must not be empty", "param": "external_submission_id", "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d" }}