{ "info": { "_postman_id": "6f1d1c7e-2d44-4d0b-9a8e-6d8a5c1f0b25", "name": "Macaaw Public API", "description": "Documents for signature, PDF tasks and webhooks. Authenticate with `Authorization: API-Key `. Pages: `?page=1&count=50` (max 100). Errors: `{ type, code, detail }`.\n\nSet the apiKey variable to your mk_test_… or mk_live_… key. Docs: https://macaaw.com/developers", "version": "1.0.0", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "API-Key {{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://macaaw.com/public/v1", "type": "string" }, { "key": "apiKey", "value": "mk_test_…", "type": "string" } ], "item": [ { "name": "Documents", "description": "", "item": [ { "name": "List documents", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/documents", "host": [ "{{baseUrl}}" ], "path": [ "documents" ], "query": [ { "key": "q", "value": "", "description": "", "disabled": true }, { "key": "status", "value": "", "description": "", "disabled": true }, { "key": "tag", "value": "", "description": "", "disabled": true }, { "key": "created_from", "value": "", "description": "", "disabled": true }, { "key": "created_to", "value": "", "description": "", "disabled": true }, { "key": "page", "value": "", "description": "", "disabled": true }, { "key": "count", "value": "", "description": "", "disabled": true }, { "key": "order_by", "value": "", "description": "", "disabled": true } ] }, "description": "" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/documents", "host": [ "{{baseUrl}}" ], "path": [ "documents" ], "query": [ { "key": "q", "value": "", "description": "", "disabled": true }, { "key": "status", "value": "", "description": "", "disabled": true }, { "key": "tag", "value": "", "description": "", "disabled": true }, { "key": "created_from", "value": "", "description": "", "disabled": true }, { "key": "created_to", "value": "", "description": "", "disabled": true }, { "key": "page", "value": "", "description": "", "disabled": true }, { "key": "count", "value": "", "description": "", "disabled": true }, { "key": "order_by", "value": "", "description": "", "disabled": true } ] }, "description": "" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"status\": \"document.uploaded\",\n \"date_created\": \"2026-10-30T11:35:00.000000Z\",\n \"date_modified\": \"2026-10-30T11:35:00.000000Z\",\n \"expiration_date\": \"2026-10-30T11:35:00.000000Z\",\n \"sandbox\": true\n }\n ]\n}", "_postman_previewlanguage": "json" }, { "name": "400 Validation error", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/documents", "host": [ "{{baseUrl}}" ], "path": [ "documents" ], "query": [ { "key": "q", "value": "", "description": "", "disabled": true }, { "key": "status", "value": "", "description": "", "disabled": true }, { "key": "tag", "value": "", "description": "", "disabled": true }, { "key": "created_from", "value": "", "description": "", "disabled": true }, { "key": "created_to", "value": "", "description": "", "disabled": true }, { "key": "page", "value": "", "description": "", "disabled": true }, { "key": "count", "value": "", "description": "", "disabled": true }, { "key": "order_by", "value": "", "description": "", "disabled": true } ] }, "description": "" }, "status": "Validation error", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Create a document from a PDF", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": [] }, { "key": "data", "type": "text", "value": "{\"name\":\"string\",\"recipients\":[{\"email\":\"client@example.com\",\"first_name\":\"string\",\"last_name\":\"string\",\"role\":\"string\",\"signing_order\":1,\"locale\":\"en\",\"type\":\"signer\"}],\"fields\":[{\"type\":\"signature\",\"role\":\"string\",\"page\":1,\"x\":0,\"y\":0,\"width\":0,\"height\":0,\"required\":true,\"name\":\"string\"}],\"parse_form_fields\":true,\"parse_text_tags\":true,\"subject\":\"string\",\"message\":\"string\",\"expires_in_days\":7,\"reminders\":true,\"access_code\":\"string\",\"tags\":[\"string\"],\"metadata\":{}}" } ] }, "url": { "raw": "{{baseUrl}}/documents", "host": [ "{{baseUrl}}" ], "path": [ "documents" ] }, "description": "Multipart: `file` (PDF) and `data` (JSON string). Text tags such as `{signature:Client}` become fields (parse_text_tags, default true); AcroForm fields named `Role.something` become fields with parse_form_fields. Unknown role → 400." }, "response": [ { "name": "201 OK", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": [] }, { "key": "data", "type": "text", "value": "{\"name\":\"string\",\"recipients\":[{\"email\":\"client@example.com\",\"first_name\":\"string\",\"last_name\":\"string\",\"role\":\"string\",\"signing_order\":1,\"locale\":\"en\",\"type\":\"signer\"}],\"fields\":[{\"type\":\"signature\",\"role\":\"string\",\"page\":1,\"x\":0,\"y\":0,\"width\":0,\"height\":0,\"required\":true,\"name\":\"string\"}],\"parse_form_fields\":true,\"parse_text_tags\":true,\"subject\":\"string\",\"message\":\"string\",\"expires_in_days\":7,\"reminders\":true,\"access_code\":\"string\",\"tags\":[\"string\"],\"metadata\":{}}" } ] }, "url": { "raw": "{{baseUrl}}/documents", "host": [ "{{baseUrl}}" ], "path": [ "documents" ] }, "description": "Multipart: `file` (PDF) and `data` (JSON string). Text tags such as `{signature:Client}` become fields (parse_text_tags, default true); AcroForm fields named `Role.something` become fields with parse_form_fields. Unknown role → 400." }, "status": "OK", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"status\": \"document.uploaded\",\n \"date_created\": \"2026-10-30T11:35:00.000000Z\",\n \"date_modified\": \"2026-10-30T11:35:00.000000Z\",\n \"expiration_date\": \"2026-10-30T11:35:00.000000Z\",\n \"sandbox\": true,\n \"uuid\": \"string\"\n}", "_postman_previewlanguage": "json" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": [] }, { "key": "data", "type": "text", "value": "{\"name\":\"string\",\"recipients\":[{\"email\":\"client@example.com\",\"first_name\":\"string\",\"last_name\":\"string\",\"role\":\"string\",\"signing_order\":1,\"locale\":\"en\",\"type\":\"signer\"}],\"fields\":[{\"type\":\"signature\",\"role\":\"string\",\"page\":1,\"x\":0,\"y\":0,\"width\":0,\"height\":0,\"required\":true,\"name\":\"string\"}],\"parse_form_fields\":true,\"parse_text_tags\":true,\"subject\":\"string\",\"message\":\"string\",\"expires_in_days\":7,\"reminders\":true,\"access_code\":\"string\",\"tags\":[\"string\"],\"metadata\":{}}" } ] }, "url": { "raw": "{{baseUrl}}/documents", "host": [ "{{baseUrl}}" ], "path": [ "documents" ] }, "description": "Multipart: `file` (PDF) and `data` (JSON string). Text tags such as `{signature:Client}` become fields (parse_text_tags, default true); AcroForm fields named `Role.something` become fields with parse_form_fields. Unknown role → 400." }, "status": "Validation error", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Document status", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/documents/:id", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/documents/:id", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"status\": \"document.uploaded\",\n \"date_created\": \"2026-10-30T11:35:00.000000Z\",\n \"date_modified\": \"2026-10-30T11:35:00.000000Z\",\n \"expiration_date\": \"2026-10-30T11:35:00.000000Z\",\n \"sandbox\": true\n}", "_postman_previewlanguage": "json" }, { "name": "400 Validation error", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/documents/:id", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "status": "Validation error", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Delete a document now (files and records)", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/documents/:id", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "response": [ { "name": "400 Validation error", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/documents/:id", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "status": "Validation error", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" }, { "name": "401 Missing, unknown or revoked API key", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/documents/:id", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "status": "Missing, unknown or revoked API key", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Document details", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/documents/:id/details", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id", "details" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/documents/:id/details", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id", "details" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"status\": \"document.uploaded\",\n \"date_created\": \"2026-10-30T11:35:00.000000Z\",\n \"date_modified\": \"2026-10-30T11:35:00.000000Z\",\n \"expiration_date\": \"2026-10-30T11:35:00.000000Z\",\n \"sandbox\": true,\n \"date_sent\": \"2026-10-30T11:35:00.000000Z\",\n \"date_completed\": \"2026-10-30T11:35:00.000000Z\",\n \"subject\": \"string\",\n \"message\": \"string\",\n \"signing_order\": \"sequential\",\n \"silent\": true,\n \"recipients\": [\n {\n \"id\": \"string\",\n \"email\": \"client@example.com\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"role\": \"string\",\n \"type\": \"signer\",\n \"signing_order\": 1,\n \"has_completed\": true,\n \"status\": \"waiting\",\n \"completed_at\": \"2026-10-30T11:35:00.000000Z\",\n \"viewed_at\": \"2026-10-30T11:35:00.000000Z\",\n \"declined_at\": \"2026-10-30T11:35:00.000000Z\"\n }\n ],\n \"fields\": [\n {\n \"id\": \"string\",\n \"type\": \"signature\",\n \"recipient_id\": \"string\",\n \"role\": \"string\",\n \"page\": 1,\n \"x\": 1,\n \"y\": 1,\n \"width\": 1,\n \"height\": 1,\n \"required\": true,\n \"name\": \"string\",\n \"filled\": true\n }\n ],\n \"tags\": [\n \"string\"\n ],\n \"metadata\": {},\n \"events\": [\n {\n \"type\": \"string\",\n \"date\": \"2026-10-30T11:35:00.000000Z\",\n \"recipient_id\": \"string\"\n }\n ],\n \"sent_by\": {\n \"email\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\"\n },\n \"download_available\": true\n}", "_postman_previewlanguage": "json" }, { "name": "400 Validation error", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/documents/:id/details", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id", "details" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "status": "Validation error", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Send a draft for signature", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"subject\": \"string\",\n \"message\": \"string\",\n \"silent\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/documents/:id/send", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id", "send" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "`silent: true` sends no emails; use embedded signing sessions. 409 unless the document is a draft." }, "response": [ { "name": "200 OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"subject\": \"string\",\n \"message\": \"string\",\n \"silent\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/documents/:id/send", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id", "send" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "`silent: true` sends no emails; use embedded signing sessions. 409 unless the document is a draft." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"status\": \"document.uploaded\",\n \"date_created\": \"2026-10-30T11:35:00.000000Z\",\n \"date_modified\": \"2026-10-30T11:35:00.000000Z\",\n \"expiration_date\": \"2026-10-30T11:35:00.000000Z\",\n \"sandbox\": true\n}", "_postman_previewlanguage": "json" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"subject\": \"string\",\n \"message\": \"string\",\n \"silent\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/documents/:id/send", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id", "send" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "`silent: true` sends no emails; use embedded signing sessions. 409 unless the document is a draft." }, "status": "Validation error", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Remind signers", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"recipient_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/documents/:id/remind", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id", "remind" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"recipient_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/documents/:id/remind", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id", "remind" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"reminded\": [\n \"string\"\n ],\n \"skipped\": [\n {\n \"recipient_id\": \"string\",\n \"reason\": \"string\"\n }\n ]\n}", "_postman_previewlanguage": "json" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"recipient_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/documents/:id/remind", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id", "remind" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "status": "Validation error", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Void a sent document", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"document.voided\",\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/documents/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id", "status" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"document.voided\",\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/documents/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id", "status" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"status\": \"document.uploaded\",\n \"date_created\": \"2026-10-30T11:35:00.000000Z\",\n \"date_modified\": \"2026-10-30T11:35:00.000000Z\",\n \"expiration_date\": \"2026-10-30T11:35:00.000000Z\",\n \"sandbox\": true\n}", "_postman_previewlanguage": "json" }, { "name": "400 Validation error", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"document.voided\",\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/documents/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id", "status" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "status": "Validation error", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Download the PDF", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/documents/:id/download", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id", "download" ], "query": [ { "key": "separate_certificate", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Completed: the signed PDF with its signing certificate. Otherwise the original. 409 while the signed PDF is being prepared." }, "response": [ { "name": "400 Validation error", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/documents/:id/download", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id", "download" ], "query": [ { "key": "separate_certificate", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Completed: the signed PDF with its signing certificate. Otherwise the original. 409 while the signed PDF is being prepared." }, "status": "Validation error", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" }, { "name": "401 Missing, unknown or revoked API key", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/documents/:id/download", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id", "download" ], "query": [ { "key": "separate_certificate", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Completed: the signed PDF with its signing certificate. Otherwise the original. 409 while the signed PDF is being prepared." }, "status": "Missing, unknown or revoked API key", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Embedded signing session", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"recipient\": \"client@example.com\",\n \"lifetime\": 900\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/documents/:id/session", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id", "session" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "For a sent document (silent or not). Open `url` in an iframe on one of your allowed embed origins; the page posts `{ type: \"macaaw.signing\", event: \"completed\"|\"declined\" }` to the parent." }, "response": [ { "name": "201 OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"recipient\": \"client@example.com\",\n \"lifetime\": 900\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/documents/:id/session", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id", "session" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "For a sent document (silent or not). Open `url` in an iframe on one of your allowed embed origins; the page posts `{ type: \"macaaw.signing\", event: \"completed\"|\"declined\" }` to the parent." }, "status": "OK", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"expires_at\": \"2026-10-30T11:35:00.000000Z\",\n \"url\": \"https://example.com/webhooks/macaaw\"\n}", "_postman_previewlanguage": "json" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"recipient\": \"client@example.com\",\n \"lifetime\": 900\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/documents/:id/session", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id", "session" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "For a sent document (silent or not). Open `url` in an iframe on one of your allowed embed origins; the page posts `{ type: \"macaaw.signing\", event: \"completed\"|\"declined\" }` to the parent." }, "status": "Validation error", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" } ] } ] }, { "name": "Tasks", "description": "", "item": [ { "name": "Tools available through the API", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/tools", "host": [ "{{baseUrl}}" ], "path": [ "tools" ] }, "description": "" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/tools", "host": [ "{{baseUrl}}" ], "path": [ "tools" ] }, "description": "" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"runs_on\": \"server\",\n \"api\": true,\n \"accepts\": [\n \"string\"\n ],\n \"max_files\": 1,\n \"min_files\": 1,\n \"plan\": \"free\",\n \"beta\": true,\n \"options\": [\n {\n \"key\": \"string\",\n \"type\": \"string\",\n \"choices\": [],\n \"default\": null,\n \"min\": 1,\n \"max\": 1,\n \"required\": true\n }\n ]\n }\n ]\n}", "_postman_previewlanguage": "json" }, { "name": "400 Validation error", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/tools", "host": [ "{{baseUrl}}" ], "path": [ "tools" ] }, "description": "" }, "status": "Validation error", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Run a server tool", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "files[]", "type": "file", "src": [] }, { "key": "data", "type": "text", "value": "{\"tool\":\"string\",\"options\":{}}" } ] }, "url": { "raw": "{{baseUrl}}/tasks", "host": [ "{{baseUrl}}" ], "path": [ "tasks" ] }, "description": "Multipart: `files[]` and `data` ({ tool, options }). The task is queued at once." }, "response": [ { "name": "201 OK", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "files[]", "type": "file", "src": [] }, { "key": "data", "type": "text", "value": "{\"tool\":\"string\",\"options\":{}}" } ] }, "url": { "raw": "{{baseUrl}}/tasks", "host": [ "{{baseUrl}}" ], "path": [ "tasks" ] }, "description": "Multipart: `files[]` and `data` ({ tool, options }). The task is queued at once." }, "status": "OK", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"tool\": \"string\",\n \"status\": \"task.queued\",\n \"error\": {\n \"code\": \"string\",\n \"detail\": \"string\"\n },\n \"input_size\": 1,\n \"output_size\": 1,\n \"output_files\": 1,\n \"stats\": {},\n \"sandbox\": true,\n \"date_created\": \"2026-10-30T11:35:00.000000Z\",\n \"date_completed\": \"2026-10-30T11:35:00.000000Z\",\n \"expires_at\": \"2026-10-30T11:35:00.000000Z\"\n}", "_postman_previewlanguage": "json" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "files[]", "type": "file", "src": [] }, { "key": "data", "type": "text", "value": "{\"tool\":\"string\",\"options\":{}}" } ] }, "url": { "raw": "{{baseUrl}}/tasks", "host": [ "{{baseUrl}}" ], "path": [ "tasks" ] }, "description": "Multipart: `files[]` and `data` ({ tool, options }). The task is queued at once." }, "status": "Validation error", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Task status", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/tasks/:id", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/tasks/:id", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"tool\": \"string\",\n \"status\": \"task.queued\",\n \"error\": {\n \"code\": \"string\",\n \"detail\": \"string\"\n },\n \"input_size\": 1,\n \"output_size\": 1,\n \"output_files\": 1,\n \"stats\": {},\n \"sandbox\": true,\n \"date_created\": \"2026-10-30T11:35:00.000000Z\",\n \"date_completed\": \"2026-10-30T11:35:00.000000Z\",\n \"expires_at\": \"2026-10-30T11:35:00.000000Z\"\n}", "_postman_previewlanguage": "json" }, { "name": "400 Validation error", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/tasks/:id", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "status": "Validation error", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Delete the task files now", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/tasks/:id", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "response": [ { "name": "400 Validation error", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/tasks/:id", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "status": "Validation error", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" }, { "name": "401 Missing, unknown or revoked API key", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/tasks/:id", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "status": "Missing, unknown or revoked API key", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Download the result (a ZIP when there are several files)", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/tasks/:id/download", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id", "download" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "response": [ { "name": "400 Validation error", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/tasks/:id/download", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id", "download" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "status": "Validation error", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" }, { "name": "401 Missing, unknown or revoked API key", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/tasks/:id/download", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id", "download" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "status": "Missing, unknown or revoked API key", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" } ] } ] }, { "name": "Invoice checks", "description": "", "item": [ { "name": "Check a supplier invoice against its PO and delivery note", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "files[]", "type": "file", "src": [] }, { "key": "data", "type": "text", "value": "{\"kinds\":[\"invoice\"]}" } ] }, "url": { "raw": "{{baseUrl}}/invoice-checks", "host": [ "{{baseUrl}}" ], "path": [ "invoice-checks" ] }, "description": "Business plan. Multipart: `files[]` (the invoice, purchase order and delivery note: PDF, JPEG or PNG; up to 10) and `data` ({ kinds? }). One invoice check is charged (allowance, then 5 credits). The documents are read at once; a person approves in the account area. Live keys only." }, "response": [ { "name": "201 OK", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "files[]", "type": "file", "src": [] }, { "key": "data", "type": "text", "value": "{\"kinds\":[\"invoice\"]}" } ] }, "url": { "raw": "{{baseUrl}}/invoice-checks", "host": [ "{{baseUrl}}" ], "path": [ "invoice-checks" ] }, "description": "Business plan. Multipart: `files[]` (the invoice, purchase order and delivery note: PDF, JPEG or PNG; up to 10) and `data` ({ kinds? }). One invoice check is charged (allowance, then 5 credits). The documents are read at once; a person approves in the account area. Live keys only." }, "status": "OK", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"status\": \"received\",\n \"supplier\": \"string\",\n \"invoice_number\": \"string\",\n \"po_number\": \"string\",\n \"dn_number\": \"string\",\n \"invoice_date\": \"string\",\n \"due_date\": \"string\",\n \"currency\": \"string\",\n \"invoiced_total_pence\": 1,\n \"matched_total_pence\": 1,\n \"difference_pence\": 1,\n \"issues\": [\n {\n \"code\": \"string\",\n \"line\": 1,\n \"amount_pence\": 1,\n \"detail\": \"string\"\n }\n ],\n \"decision\": null,\n \"approved_amount_pence\": 1,\n \"documents\": [\n {\n \"id\": \"string\",\n \"kind\": null,\n \"status\": \"pending\"\n }\n ],\n \"lines\": [\n {\n \"position\": 1,\n \"description\": \"string\",\n \"result\": \"string\",\n \"amount_at_stake_pence\": 1\n }\n ],\n \"url\": \"https://example.com/webhooks/macaaw\",\n \"date_created\": \"2026-10-30T11:35:00.000000Z\",\n \"date_modified\": \"2026-10-30T11:35:00.000000Z\"\n}", "_postman_previewlanguage": "json" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "files[]", "type": "file", "src": [] }, { "key": "data", "type": "text", "value": "{\"kinds\":[\"invoice\"]}" } ] }, "url": { "raw": "{{baseUrl}}/invoice-checks", "host": [ "{{baseUrl}}" ], "path": [ "invoice-checks" ] }, "description": "Business plan. Multipart: `files[]` (the invoice, purchase order and delivery note: PDF, JPEG or PNG; up to 10) and `data` ({ kinds? }). One invoice check is charged (allowance, then 5 credits). The documents are read at once; a person approves in the account area. Live keys only." }, "status": "Validation error", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Invoice check status and result", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/invoice-checks/:id", "host": [ "{{baseUrl}}" ], "path": [ "invoice-checks", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/invoice-checks/:id", "host": [ "{{baseUrl}}" ], "path": [ "invoice-checks", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"status\": \"received\",\n \"supplier\": \"string\",\n \"invoice_number\": \"string\",\n \"po_number\": \"string\",\n \"dn_number\": \"string\",\n \"invoice_date\": \"string\",\n \"due_date\": \"string\",\n \"currency\": \"string\",\n \"invoiced_total_pence\": 1,\n \"matched_total_pence\": 1,\n \"difference_pence\": 1,\n \"issues\": [\n {\n \"code\": \"string\",\n \"line\": 1,\n \"amount_pence\": 1,\n \"detail\": \"string\"\n }\n ],\n \"decision\": null,\n \"approved_amount_pence\": 1,\n \"documents\": [\n {\n \"id\": \"string\",\n \"kind\": null,\n \"status\": \"pending\"\n }\n ],\n \"lines\": [\n {\n \"position\": 1,\n \"description\": \"string\",\n \"result\": \"string\",\n \"amount_at_stake_pence\": 1\n }\n ],\n \"url\": \"https://example.com/webhooks/macaaw\",\n \"date_created\": \"2026-10-30T11:35:00.000000Z\",\n \"date_modified\": \"2026-10-30T11:35:00.000000Z\"\n}", "_postman_previewlanguage": "json" }, { "name": "400 Validation error", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/invoice-checks/:id", "host": [ "{{baseUrl}}" ], "path": [ "invoice-checks", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "status": "Validation error", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" } ] } ] }, { "name": "Webhooks", "description": "", "item": [ { "name": "List webhook subscriptions", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/webhook-subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "webhook-subscriptions" ] }, "description": "" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/webhook-subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "webhook-subscriptions" ] }, "description": "" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"uuid\": \"string\",\n \"name\": \"string\",\n \"url\": \"https://example.com/webhooks/macaaw\",\n \"triggers\": [\n \"document_state_changed\"\n ],\n \"active\": true,\n \"sandbox\": true,\n \"deactivated_reason\": null,\n \"date_created\": \"2026-10-30T11:35:00.000000Z\",\n \"date_modified\": \"2026-10-30T11:35:00.000000Z\"\n }\n ]\n}", "_postman_previewlanguage": "json" }, { "name": "400 Validation error", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/webhook-subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "webhook-subscriptions" ] }, "description": "" }, "status": "Validation error", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Create a webhook subscription", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"url\": \"https://example.com/webhooks/macaaw\",\n \"triggers\": [\n \"document_state_changed\"\n ],\n \"active\": true,\n \"sandbox\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhook-subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "webhook-subscriptions" ] }, "description": "https only, public hosts only (private, loopback, link-local and metadata addresses are refused). The shared key is shown once." }, "response": [ { "name": "201 OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"url\": \"https://example.com/webhooks/macaaw\",\n \"triggers\": [\n \"document_state_changed\"\n ],\n \"active\": true,\n \"sandbox\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhook-subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "webhook-subscriptions" ] }, "description": "https only, public hosts only (private, loopback, link-local and metadata addresses are refused). The shared key is shown once." }, "status": "OK", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"uuid\": \"string\",\n \"name\": \"string\",\n \"url\": \"https://example.com/webhooks/macaaw\",\n \"triggers\": [\n \"document_state_changed\"\n ],\n \"active\": true,\n \"sandbox\": true,\n \"deactivated_reason\": null,\n \"date_created\": \"2026-10-30T11:35:00.000000Z\",\n \"date_modified\": \"2026-10-30T11:35:00.000000Z\",\n \"shared_key\": \"string\"\n}", "_postman_previewlanguage": "json" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"url\": \"https://example.com/webhooks/macaaw\",\n \"triggers\": [\n \"document_state_changed\"\n ],\n \"active\": true,\n \"sandbox\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhook-subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "webhook-subscriptions" ] }, "description": "https only, public hosts only (private, loopback, link-local and metadata addresses are refused). The shared key is shown once." }, "status": "Validation error", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Get a webhook subscription", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/webhook-subscriptions/:uuid", "host": [ "{{baseUrl}}" ], "path": [ "webhook-subscriptions", ":uuid" ], "variable": [ { "key": "uuid", "value": "", "description": "" } ] }, "description": "" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/webhook-subscriptions/:uuid", "host": [ "{{baseUrl}}" ], "path": [ "webhook-subscriptions", ":uuid" ], "variable": [ { "key": "uuid", "value": "", "description": "" } ] }, "description": "" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"uuid\": \"string\",\n \"name\": \"string\",\n \"url\": \"https://example.com/webhooks/macaaw\",\n \"triggers\": [\n \"document_state_changed\"\n ],\n \"active\": true,\n \"sandbox\": true,\n \"deactivated_reason\": null,\n \"date_created\": \"2026-10-30T11:35:00.000000Z\",\n \"date_modified\": \"2026-10-30T11:35:00.000000Z\"\n}", "_postman_previewlanguage": "json" }, { "name": "400 Validation error", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/webhook-subscriptions/:uuid", "host": [ "{{baseUrl}}" ], "path": [ "webhook-subscriptions", ":uuid" ], "variable": [ { "key": "uuid", "value": "", "description": "" } ] }, "description": "" }, "status": "Validation error", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Update a webhook subscription", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"url\": \"https://example.com/webhooks/macaaw\",\n \"triggers\": [\n \"document_state_changed\"\n ],\n \"active\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhook-subscriptions/:uuid", "host": [ "{{baseUrl}}" ], "path": [ "webhook-subscriptions", ":uuid" ], "variable": [ { "key": "uuid", "value": "", "description": "" } ] }, "description": "" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"url\": \"https://example.com/webhooks/macaaw\",\n \"triggers\": [\n \"document_state_changed\"\n ],\n \"active\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhook-subscriptions/:uuid", "host": [ "{{baseUrl}}" ], "path": [ "webhook-subscriptions", ":uuid" ], "variable": [ { "key": "uuid", "value": "", "description": "" } ] }, "description": "" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"uuid\": \"string\",\n \"name\": \"string\",\n \"url\": \"https://example.com/webhooks/macaaw\",\n \"triggers\": [\n \"document_state_changed\"\n ],\n \"active\": true,\n \"sandbox\": true,\n \"deactivated_reason\": null,\n \"date_created\": \"2026-10-30T11:35:00.000000Z\",\n \"date_modified\": \"2026-10-30T11:35:00.000000Z\"\n}", "_postman_previewlanguage": "json" }, { "name": "400 Validation error", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"url\": \"https://example.com/webhooks/macaaw\",\n \"triggers\": [\n \"document_state_changed\"\n ],\n \"active\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhook-subscriptions/:uuid", "host": [ "{{baseUrl}}" ], "path": [ "webhook-subscriptions", ":uuid" ], "variable": [ { "key": "uuid", "value": "", "description": "" } ] }, "description": "" }, "status": "Validation error", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Delete a webhook subscription", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/webhook-subscriptions/:uuid", "host": [ "{{baseUrl}}" ], "path": [ "webhook-subscriptions", ":uuid" ], "variable": [ { "key": "uuid", "value": "", "description": "" } ] }, "description": "" }, "response": [ { "name": "400 Validation error", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/webhook-subscriptions/:uuid", "host": [ "{{baseUrl}}" ], "path": [ "webhook-subscriptions", ":uuid" ], "variable": [ { "key": "uuid", "value": "", "description": "" } ] }, "description": "" }, "status": "Validation error", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" }, { "name": "401 Missing, unknown or revoked API key", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/webhook-subscriptions/:uuid", "host": [ "{{baseUrl}}" ], "path": [ "webhook-subscriptions", ":uuid" ], "variable": [ { "key": "uuid", "value": "", "description": "" } ] }, "description": "" }, "status": "Missing, unknown or revoked API key", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Regenerate the shared key", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/webhook-subscriptions/:uuid/shared-key", "host": [ "{{baseUrl}}" ], "path": [ "webhook-subscriptions", ":uuid", "shared-key" ], "variable": [ { "key": "uuid", "value": "", "description": "" } ] }, "description": "" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/webhook-subscriptions/:uuid/shared-key", "host": [ "{{baseUrl}}" ], "path": [ "webhook-subscriptions", ":uuid", "shared-key" ], "variable": [ { "key": "uuid", "value": "", "description": "" } ] }, "description": "" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"uuid\": \"string\",\n \"shared_key\": \"string\"\n}", "_postman_previewlanguage": "json" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/webhook-subscriptions/:uuid/shared-key", "host": [ "{{baseUrl}}" ], "path": [ "webhook-subscriptions", ":uuid", "shared-key" ], "variable": [ { "key": "uuid", "value": "", "description": "" } ] }, "description": "" }, "status": "Validation error", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Delivery history", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/webhook-events", "host": [ "{{baseUrl}}" ], "path": [ "webhook-events" ], "query": [ { "key": "subscription", "value": "", "description": "", "disabled": true }, { "key": "status", "value": "", "description": "", "disabled": true }, { "key": "page", "value": "", "description": "", "disabled": true }, { "key": "count", "value": "", "description": "", "disabled": true } ] }, "description": "" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/webhook-events", "host": [ "{{baseUrl}}" ], "path": [ "webhook-events" ], "query": [ { "key": "subscription", "value": "", "description": "", "disabled": true }, { "key": "status", "value": "", "description": "", "disabled": true }, { "key": "page", "value": "", "description": "", "disabled": true }, { "key": "count", "value": "", "description": "", "disabled": true } ] }, "description": "" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"id\": \"string\",\n \"subscription\": \"string\",\n \"event\": \"string\",\n \"events\": [\n \"string\"\n ],\n \"status\": \"pending\",\n \"attempts\": 1,\n \"http_status\": 1,\n \"error\": \"string\",\n \"response\": \"string\",\n \"date_created\": \"2026-10-30T11:35:00.000000Z\",\n \"delivered_at\": \"2026-10-30T11:35:00.000000Z\",\n \"next_attempt_at\": \"2026-10-30T11:35:00.000000Z\"\n }\n ]\n}", "_postman_previewlanguage": "json" }, { "name": "400 Validation error", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/webhook-events", "host": [ "{{baseUrl}}" ], "path": [ "webhook-events" ], "query": [ { "key": "subscription", "value": "", "description": "", "disabled": true }, { "key": "status", "value": "", "description": "", "disabled": true }, { "key": "page", "value": "", "description": "", "disabled": true }, { "key": "count", "value": "", "description": "", "disabled": true } ] }, "description": "" }, "status": "Validation error", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Resend a delivery now", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/webhook-events/:id/resend", "host": [ "{{baseUrl}}" ], "path": [ "webhook-events", ":id", "resend" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/webhook-events/:id/resend", "host": [ "{{baseUrl}}" ], "path": [ "webhook-events", ":id", "resend" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"subscription\": \"string\",\n \"event\": \"string\",\n \"events\": [\n \"string\"\n ],\n \"status\": \"pending\",\n \"attempts\": 1,\n \"http_status\": 1,\n \"error\": \"string\",\n \"response\": \"string\",\n \"date_created\": \"2026-10-30T11:35:00.000000Z\",\n \"delivered_at\": \"2026-10-30T11:35:00.000000Z\",\n \"next_attempt_at\": \"2026-10-30T11:35:00.000000Z\"\n}", "_postman_previewlanguage": "json" }, { "name": "400 Validation error", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/webhook-events/:id/resend", "host": [ "{{baseUrl}}" ], "path": [ "webhook-events", ":id", "resend" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" }, "status": "Validation error", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"request_error\",\n \"code\": \"string\",\n \"detail\": \"string\",\n \"info\": {}\n}", "_postman_previewlanguage": "json" } ] } ] }, { "name": "Meta", "description": "", "item": [ { "name": "This OpenAPI document", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/openapi.json", "host": [ "{{baseUrl}}" ], "path": [ "openapi.json" ] }, "description": "" }, "response": [] } ] } ] }