{ "item": [ { "name": "api-keys", "description": "", "item": [ { "id": "56113cb6-4cc1-4414-999e-f64ac5bfa833", "name": "Create Api Key", "request": { "name": "Create Api Key", "description": { "content": "Generate a new API key.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_email\": \"\",\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e23b23a6-bf29-4669-bc45-9703df956918", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_email\": \"\",\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"api_key\": \"\",\n \"key\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"label\": \"\",\n \"user_email\": \"\",\n \"revoked\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cde1a55-b830-45bd-adfc-6cb0b2c22835", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_email\": \"\",\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "54b6d655-dc40-4832-a91f-a63db5580103", "name": "List Api Keys", "request": { "name": "List Api Keys", "description": { "content": "List API keys without exposing the secret.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d4704526-f8e5-41f3-9517-2ba76bcdec89", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"keys\": [\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"label\": \"\",\n \"user_email\": \"\",\n \"revoked\": false\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"label\": \"\",\n \"user_email\": \"\",\n \"revoked\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "921208dc-f698-4182-b5d2-202918104408", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8c18e5a8-7859-4bf0-a7e6-0bdc16218360", "name": "Rotate Api Key", "request": { "name": "Rotate Api Key", "description": { "content": "Rotate the current API key (revoke + create).", "type": "text/plain" }, "url": { "path": [ "api", "v1", "api-keys", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_email\": \"\",\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9beed167-77fa-4999-8cb5-2f2ff293eeeb", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "api-keys", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_email\": \"\",\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"api_key\": \"\",\n \"key\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"label\": \"\",\n \"user_email\": \"\",\n \"revoked\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81dc2364-7032-46fd-ab3c-1bd1560fdf26", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "api-keys", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_email\": \"\",\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d80ccfe7-8ab9-4d37-b69a-4a5c15507810", "name": "Revoke Api Key", "request": { "name": "Revoke Api Key", "description": { "content": "Revoke an API key.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "api-keys", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "04412e46-d68b-4796-b75b-0aaf0bcdf725", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "api-keys", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"revoked\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57532353-839d-4414-8989-cde79bb6e725", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "api-keys", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "billing", "description": "", "item": [ { "id": "2b8aec2b-6a83-4b5d-8684-ce2214554cbf", "name": "Create Checkout Session", "request": { "name": "Create Checkout Session", "description": { "content": "Create a Stripe checkout session for plan upgrade.\n\nHYBRID AUTH: Supports both JWT dashboard users and API key clients.\n\nAuthentication:\n - Dashboard users: JWT access token (Authorization: Bearer)\n - API clients: API key (X-API-Key header)\n - Auto-refresh: refresh_token cookie → new JWT", "type": "text/plain" }, "url": { "path": [ "api", "v1", "me", "billing", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"plan_code\": \"pro\",\n \"source\": \"\",\n \"trigger_event\": \"\",\n \"from_endpoint\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9664befa-790f-42fa-b8c7-da304c650d24", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "me", "billing", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"plan_code\": \"pro\",\n \"source\": \"\",\n \"trigger_event\": \"\",\n \"from_endpoint\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"checkout_url\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ebf75ac-7564-4493-a62f-67bf6198d95b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "me", "billing", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"plan_code\": \"pro\",\n \"source\": \"\",\n \"trigger_event\": \"\",\n \"from_endpoint\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7d18fb4c-4464-4e0b-b579-8af5a572a267", "name": "Create Portal Session", "request": { "name": "Create Portal Session", "description": { "content": "Create a Stripe Customer Portal session for managing subscription.\n\nHYBRID AUTH: Supports both JWT dashboard users and API key clients.\n\nThe portal allows users to:\n- Update payment method\n- Cancel subscription\n- View billing history\n- Download invoices\n\nIf the user has no Stripe customer ID yet (never completed checkout),\nreturns 400 with guidance to complete checkout first.\n\nAuthentication:\n - Dashboard users: JWT access token (Authorization: Bearer)\n - API clients: API key (X-API-Key header)\n - Auto-refresh: refresh_token cookie → new JWT", "type": "text/plain" }, "url": { "path": [ "api", "v1", "me", "billing", "portal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "85720e4a-91c1-46c8-8b1b-7e698dc179c9", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "me", "billing", "portal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"url\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ebe36f4-aba2-41db-a0c0-43b76f298c1c", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "me", "billing", "portal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "credits", "description": "", "item": [ { "id": "0a0e2b75-a907-4b43-8bd1-7de98b0b3523", "name": "Create Credit Checkout", "request": { "name": "Create Credit Checkout", "description": { "content": "Create a Stripe checkout session for a credit pack purchase.\n\nOne-time payment (mode=payment, not subscription).\nGated behind CREDIT_SYSTEM_ENABLED feature flag.\nCredits are added to the user's balance via webhook on successful payment.\n\nHYBRID AUTH: Supports both JWT dashboard users and API key clients.", "type": "text/plain" }, "url": { "path": [ "credits", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "bd66adc9-7331-4297-8604-404383d8c12c", "name": "Successful Response", "originalRequest": { "url": { "path": [ "credits", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"checkout_url\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7bd9876-cbfa-453e-b5af-8147d9cde586", "name": "Validation Error", "originalRequest": { "url": { "path": [ "credits", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "me", "description": "", "item": [ { "id": "7d6113bc-712c-415c-a840-1fda4b9e5384", "name": "List My Api Keys", "request": { "name": "List My Api Keys", "description": {}, "url": { "path": [ "api", "v1", "me", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c9144d74-3132-49dc-837d-b9a61f1a98a2", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "me", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"keys\": [\n {\n \"id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"label\": \"\",\n \"plan\": \"\",\n \"revoked\": false\n },\n {\n \"id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"label\": \"\",\n \"plan\": \"\",\n \"revoked\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "516b698e-8606-40a2-89d7-968dc804792f", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "me", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b0d82541-eeb0-4558-a0cb-fdde49fd0170", "name": "Create My Api Key", "request": { "name": "Create My Api Key", "description": {}, "url": { "path": [ "api", "v1", "me", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"plan_code\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5337505a-4e58-434b-aa7f-0abfeb7a49f2", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "me", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"plan_code\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"api_key\": \"\",\n \"key\": {\n \"id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"label\": \"\",\n \"plan\": \"\",\n \"revoked\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "557f93cd-3836-4b52-828c-dc5907f08c0c", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "me", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"plan_code\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a0642d9a-f091-43a1-b796-7b44a372704a", "name": "Revoke My Api Key", "request": { "name": "Revoke My Api Key", "description": {}, "url": { "path": [ "api", "v1", "me", "api-keys", ":key_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "key_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "0315f8e7-d22a-40df-98a5-47c9d42439ef", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "me", "api-keys", ":key_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "key_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "382e7e89-b0e5-4d70-b758-bc1924c0ade4", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "me", "api-keys", ":key_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "key_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5c0755e9-6f8e-4c52-88ef-3571c1eaa973", "name": "Get My Usage", "request": { "name": "Get My Usage", "description": {}, "url": { "path": [ "api", "v1", "me", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "97d0111c-edb7-4d51-abee-c30d17ea1b69", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "me", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"plan\": \"\",\n \"quota\": \"\",\n \"count\": \"\",\n \"period_start\": \"\",\n \"period_end\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "140ec6ac-2fa0-4732-be82-85cd419a612b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "me", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "76891699-6f40-4be1-979f-5935b187488d", "name": "Get Me Summary", "request": { "name": "Get Me Summary", "description": { "content": "Get account summary: email, plan, and current usage.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7285779f-a0db-4104-99fa-2196d6ca5404", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"email\": \"\",\n \"plan\": {\n \"code\": \"\",\n \"monthly_quota\": \"\"\n },\n \"usage\": {\n \"period_start\": \"\",\n \"period_end\": \"\",\n \"count\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "495b70e7-5f3b-4d76-b999-aa6644765123", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "21d2c1c7-8ea5-41e2-aa84-af233501ce83", "name": "List My Validations", "request": { "name": "List My Validations", "description": { "content": "List validation runs with cursor-based pagination.\n\n**Paid tier feature**: Requires Integration or Business plan (legacy Pro grandfathered).\n\nQuery parameters:\n- limit: Max results per page (default 50, max 200)\n- cursor: Pagination cursor from previous response\n- status: Filter by 'valid' or 'invalid'\n- profile: Filter by Factur-X profile (MINIMUM, BASIC, EN16931)\n- from: ISO date filter (inclusive)\n- to: ISO date filter (exclusive)", "type": "text/plain" }, "url": { "path": [ "api", "v1", "me", "validations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "status_filter", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "profile", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "to_date", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d7d11716-8b20-4c7f-a16b-215c6682a604", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "me", "validations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "status_filter", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "profile", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "to_date", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"source\": \"\",\n \"is_valid\": \"\",\n \"error_count\": \"\",\n \"warning_count\": \"\",\n \"duration_ms\": \"\",\n \"profile\": \"\",\n \"filename\": \"\"\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"source\": \"\",\n \"is_valid\": \"\",\n \"error_count\": \"\",\n \"warning_count\": \"\",\n \"duration_ms\": \"\",\n \"profile\": \"\",\n \"filename\": \"\"\n }\n ],\n \"next_cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86e7ef35-d507-41ea-8120-f4b5ebe326cc", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "me", "validations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "status_filter", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "profile", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "to_date", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0f513074-7266-47fe-8bd9-3a2d7bee55ad", "name": "Export My Validations", "request": { "name": "Export My Validations", "description": { "content": "Export validation history as CSV or JSON.\n\n**Paid tier feature**: Requires Integration or Business plan (legacy Pro grandfathered).\n\nExports up to 30 days of validation history.\n\nQuery parameters:\n- format: 'csv' or 'json' (required)\n- status: Filter by 'valid' or 'invalid'\n- profile: Filter by Factur-X profile (MINIMUM, BASIC, EN16931)\n- from: ISO date filter (inclusive)\n- to: ISO date filter (exclusive)\n\nRGPD-safe: Does not include document content, hash, or error messages.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "me", "validations", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Export format: csv or json (This can only be one of csv,json)", "type": "text/plain" }, "key": "format", "value": "csv" }, { "disabled": false, "description": { "content": "Filter: valid or invalid", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Filter by Factur-X profile", "type": "text/plain" }, "key": "profile", "value": "" }, { "disabled": false, "description": { "content": "Start date (ISO format)", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "End date (ISO format)", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e6ccde38-6ba6-4c37-935b-be2da929be1d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "me", "validations", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Export format: csv or json (This can only be one of csv,json)", "type": "text/plain" }, "key": "format", "value": "csv" }, { "disabled": false, "description": { "content": "Filter: valid or invalid", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Filter by Factur-X profile", "type": "text/plain" }, "key": "profile", "value": "" }, { "disabled": false, "description": { "content": "Start date (ISO format)", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "End date (ISO format)", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee61242c-120a-4f06-bb8a-dd4cb5af7b08", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "me", "validations", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Export format: csv or json (This can only be one of csv,json)", "type": "text/plain" }, "key": "format", "value": "csv" }, { "disabled": false, "description": { "content": "Filter: valid or invalid", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Filter by Factur-X profile", "type": "text/plain" }, "key": "profile", "value": "" }, { "disabled": false, "description": { "content": "Start date (ISO format)", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "End date (ISO format)", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "381407fe-c7be-46fb-8f67-9300910d8e5b", "name": "Get My Validation", "request": { "name": "Get My Validation", "description": { "content": "Get detailed validation run by ID.\n\n**Paid tier feature**: Requires Integration or Business plan (legacy Pro grandfathered).\n\nReturns full details including RGPD-safe issues summary\n(code/field/severity only, no messages or values).", "type": "text/plain" }, "url": { "path": [ "api", "v1", "me", "validations", ":run_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "run_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b634143b-c249-4324-9d12-97d670789424", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "me", "validations", ":run_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "run_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"created_at\": \"\",\n \"source\": \"\",\n \"is_valid\": \"\",\n \"error_count\": \"\",\n \"warning_count\": \"\",\n \"duration_ms\": \"\",\n \"profile\": \"\",\n \"filename\": \"\",\n \"issues_top\": [\n {\n \"severity\": \"\",\n \"code\": \"\",\n \"field\": \"\"\n },\n {\n \"severity\": \"\",\n \"code\": \"\",\n \"field\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28e8b205-c05b-4908-8726-ff901edf6566", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "me", "validations", ":run_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "run_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "admin", "description": "", "item": [ { "id": "b7bd06c3-7b31-4048-8ff3-c840b66dc854", "name": "Admin Ping", "request": { "name": "Admin Ping", "description": { "content": "Lightweight endpoint for token validation without touching D1.", "type": "text/plain" }, "url": { "path": [ "admin", "ping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9f23b885-11f4-4b8f-a499-663ce8681f78", "name": "Successful Response", "originalRequest": { "url": { "path": [ "admin", "ping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ccc3fb9-33ed-4346-bb64-43e7c8b022d8", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "ping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6fabc0c3-414b-48fd-876c-ebee2ed55f6f", "name": "Admin Debug Consent Records", "request": { "name": "Admin Debug Consent Records", "description": { "content": "Debug consent records — failed conversions where user opted in to file retention.\n\nShows: active artifacts (not yet cleaned), recent consents, error breakdown.", "type": "text/plain" }, "url": { "path": [ "admin", "debug-consent", "records" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9e49ebc6-8360-4f5b-a0c2-302e147fb14a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "admin", "debug-consent", "records" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96a81f91-b6cf-4e25-a21e-6fbe274e6666", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "debug-consent", "records" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "781b37d4-c6a6-4474-9431-36170901bc94", "name": "Admin Debug Consent Cleanup", "request": { "name": "Admin Debug Consent Cleanup", "description": { "content": "Trigger cleanup of expired debug consent artifacts.\n\nDeletes R2 objects for consents past their 72h TTL and marks\nrecords as deleted. Safe to call multiple times (idempotent).", "type": "text/plain" }, "url": { "path": [ "admin", "debug-consent", "cleanup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "203b3fb2-9f79-4f62-8c16-6394314303ef", "name": "Successful Response", "originalRequest": { "url": { "path": [ "admin", "debug-consent", "cleanup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23e406f5-1fbf-4457-984d-1adc07239777", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "debug-consent", "cleanup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "62213ed8-c021-4042-8b70-4791fa1c4012", "name": "Admin Escalation Stats", "request": { "name": "Admin Escalation Stats", "description": { "content": "Shadow mode monitoring dashboard data.\n\nReturns:\n- runtime: in-memory counters since last deploy (volume, parity, confidence)\n- suppliers: persistent D1 data (known suppliers, top by observations)\n- config: current escalation feature flags", "type": "text/plain" }, "url": { "path": [ "admin", "escalation", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3cc3d92b-10a4-408f-ab6c-4b440de834a6", "name": "Successful Response", "originalRequest": { "url": { "path": [ "admin", "escalation", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ede359d3-8e2f-4b15-992f-51bf3cf46786", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "escalation", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d293b0af-69d1-48bd-bdb9-cfb59dfbf112", "name": "Admin Convert Rollout Guard Test Alert", "request": { "name": "Admin Convert Rollout Guard Test Alert", "description": {}, "url": { "path": [ "admin", "convert", "rollout-guard", "test-alert" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"rule\": \"failed_spike_1h\",\n \"current_rate\": \"\",\n \"baseline_rate\": \"\",\n \"current_count\": \"\",\n \"baseline_count\": \"\",\n \"current_total\": \"\",\n \"baseline_total\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2fb5913e-67de-4111-840c-a99da90b943d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "admin", "convert", "rollout-guard", "test-alert" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"rule\": \"failed_spike_1h\",\n \"current_rate\": \"\",\n \"baseline_rate\": \"\",\n \"current_count\": \"\",\n \"baseline_count\": \"\",\n \"current_total\": \"\",\n \"baseline_total\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": \"\",\n \"alert\": {},\n \"results\": [\n {\n \"channel\": \"paging\",\n \"configured\": \"\",\n \"attempted\": \"\",\n \"delivered\": \"\",\n \"payload_event\": \"\",\n \"reason\": \"\"\n },\n {\n \"channel\": \"dashboard\",\n \"configured\": \"\",\n \"attempted\": \"\",\n \"delivered\": \"\",\n \"payload_event\": \"\",\n \"reason\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "baf9797a-ca9d-44ac-9290-c33a3cc2b951", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "convert", "rollout-guard", "test-alert" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"rule\": \"failed_spike_1h\",\n \"current_rate\": \"\",\n \"baseline_rate\": \"\",\n \"current_count\": \"\",\n \"baseline_count\": \"\",\n \"current_total\": \"\",\n \"baseline_total\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8608dd4c-8fc2-4a16-954b-1d07a336b982", "name": "Admin Convert Rollout Guard Preflight", "request": { "name": "Admin Convert Rollout Guard Preflight", "description": {}, "url": { "path": [ "admin", "convert", "rollout-guard", "preflight" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d0cff639-473a-40d0-a011-f596d5b0ff8c", "name": "Successful Response", "originalRequest": { "url": { "path": [ "admin", "convert", "rollout-guard", "preflight" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": \"\",\n \"enabled\": \"\",\n \"automation_enabled\": \"\",\n \"automation_dry_run\": \"\",\n \"bearer_token_configured\": \"\",\n \"webhook_timeout_seconds\": \"\",\n \"max_pending_dispatches\": \"\",\n \"reserved_critical_pending_slots\": \"\",\n \"issues\": [\n \"\",\n \"\"\n ],\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"rule\": \"fallback_spike_24h\",\n \"ok\": \"\",\n \"channels\": [\n {\n \"channel\": \"paging\",\n \"configured\": \"\",\n \"eligible\": \"\",\n \"payload_event\": \"\",\n \"reason\": \"\"\n },\n {\n \"channel\": \"automation\",\n \"configured\": \"\",\n \"eligible\": \"\",\n \"payload_event\": \"\",\n \"reason\": \"\"\n }\n ]\n },\n {\n \"rule\": \"fallback_spike_24h\",\n \"ok\": \"\",\n \"channels\": [\n {\n \"channel\": \"automation\",\n \"configured\": \"\",\n \"eligible\": \"\",\n \"payload_event\": \"\",\n \"reason\": \"\"\n },\n {\n \"channel\": \"paging\",\n \"configured\": \"\",\n \"eligible\": \"\",\n \"payload_event\": \"\",\n \"reason\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6ebeda0-e124-4019-8225-8ce3cb1cd718", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "convert", "rollout-guard", "preflight" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ce42b0e1-4133-47ad-9bc3-c4aa6b3dd31c", "name": "Admin Convert Prod Readiness", "request": { "name": "Admin Convert Prod Readiness", "description": {}, "url": { "path": [ "admin", "convert", "prod-readiness" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8990e685-4d54-43de-9b78-c585e44a7c59", "name": "Successful Response", "originalRequest": { "url": { "path": [ "admin", "convert", "prod-readiness" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": \"\",\n \"summary\": {\n \"pass_count\": \"\",\n \"warn_count\": \"\",\n \"fail_count\": \"\"\n },\n \"items\": [\n {\n \"key\": \"\",\n \"status\": \"warn\",\n \"reason\": \"\",\n \"detail\": {}\n },\n {\n \"key\": \"\",\n \"status\": \"pass\",\n \"reason\": \"\",\n \"detail\": {}\n }\n ],\n \"rollout_guard\": {\n \"ok\": \"\",\n \"enabled\": \"\",\n \"automation_enabled\": \"\",\n \"automation_dry_run\": \"\",\n \"bearer_token_configured\": \"\",\n \"webhook_timeout_seconds\": \"\",\n \"max_pending_dispatches\": \"\",\n \"reserved_critical_pending_slots\": \"\",\n \"issues\": [\n \"\",\n \"\"\n ],\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"rule\": \"fallback_spike_24h\",\n \"ok\": \"\",\n \"channels\": [\n {\n \"channel\": \"automation\",\n \"configured\": \"\",\n \"eligible\": \"\",\n \"payload_event\": \"\",\n \"reason\": \"\"\n },\n {\n \"channel\": \"paging\",\n \"configured\": \"\",\n \"eligible\": \"\",\n \"payload_event\": \"\",\n \"reason\": \"\"\n }\n ]\n },\n {\n \"rule\": \"failed_spike_1h\",\n \"ok\": \"\",\n \"channels\": [\n {\n \"channel\": \"paging\",\n \"configured\": \"\",\n \"eligible\": \"\",\n \"payload_event\": \"\",\n \"reason\": \"\"\n },\n {\n \"channel\": \"automation\",\n \"configured\": \"\",\n \"eligible\": \"\",\n \"payload_event\": \"\",\n \"reason\": \"\"\n }\n ]\n }\n ]\n },\n \"environment\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80302ded-f3bd-4f6d-ac22-9b7809c7577f", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "convert", "prod-readiness" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3d99195f-5983-4bb1-8fdd-138d8fb26831", "name": "Admin System Config", "request": { "name": "Admin System Config", "description": {}, "url": { "path": [ "admin", "system", "config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d443d804-e3a4-4355-8423-3cfa25e7eedd", "name": "Successful Response", "originalRequest": { "url": { "path": [ "admin", "system", "config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00687c51-9da5-40a7-85b8-899be710b87d", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "system", "config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1feb836a-7568-4c8c-b993-d6fe75cb44a5", "name": "Admin Usage Periods", "request": { "name": "Admin Usage Periods", "description": { "content": "Get available usage periods for the period selector.", "type": "text/plain" }, "url": { "path": [ "admin", "usage", "periods" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "08163966-4a08-45ed-bf79-5222dc6e959b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "admin", "usage", "periods" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d285668d-7d96-41b6-8114-ef52b8898b3a", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "usage", "periods" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "12f7794b-3ed5-4016-8ec3-39598b730017", "name": "Admin Usage", "request": { "name": "Admin Usage", "description": {}, "url": { "path": [ "admin", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Include users without current-period usage counters", "type": "text/plain" }, "key": "include_zero", "value": "true" }, { "disabled": false, "description": { "content": "Period start date (YYYY-MM-01 format) or 'all' for all-time. Defaults to current month.", "type": "text/plain" }, "key": "period_start", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d5d13f12-644d-485e-9844-b52224f56f6f", "name": "Successful Response", "originalRequest": { "url": { "path": [ "admin", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Include users without current-period usage counters", "type": "text/plain" }, "key": "include_zero", "value": "true" }, { "disabled": false, "description": { "content": "Period start date (YYYY-MM-01 format) or 'all' for all-time. Defaults to current month.", "type": "text/plain" }, "key": "period_start", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46191dff-8522-4d78-918d-c4e316728b62", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Include users without current-period usage counters", "type": "text/plain" }, "key": "include_zero", "value": "true" }, { "disabled": false, "description": { "content": "Period start date (YYYY-MM-01 format) or 'all' for all-time. Defaults to current month.", "type": "text/plain" }, "key": "period_start", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9db1dee8-98c3-4614-bca5-246a70e380ac", "name": "Admin Users Summary", "request": { "name": "Admin Users Summary", "description": {}, "url": { "path": [ "admin", "users", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Start date (YYYY-MM-DD)", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "End date (YYYY-MM-DD)", "type": "text/plain" }, "key": "to", "value": "" }, { "disabled": false, "description": { "content": "Max users to return", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Offset for pagination", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Sort field: last_activity_at, usage_api, usage_ui, keys_total_count", "type": "text/plain" }, "key": "sort", "value": "last_activity_at" }, { "disabled": false, "description": { "content": "Sort order", "type": "text/plain" }, "key": "sort_order", "value": "desc" }, { "disabled": false, "description": { "content": "Filter by plan code (free/pro)", "type": "text/plain" }, "key": "plan", "value": "" }, { "disabled": false, "description": { "content": "Filter users with API usage", "type": "text/plain" }, "key": "activated_api", "value": "" }, { "disabled": false, "description": { "content": "Filter users with UI usage", "type": "text/plain" }, "key": "activated_ui", "value": "" }, { "disabled": false, "description": { "content": "Filter by email domain", "type": "text/plain" }, "key": "email_domain", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "fe77d9b2-88e1-4042-a879-1d463cd591b4", "name": "Successful Response", "originalRequest": { "url": { "path": [ "admin", "users", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Start date (YYYY-MM-DD)", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "End date (YYYY-MM-DD)", "type": "text/plain" }, "key": "to", "value": "" }, { "disabled": false, "description": { "content": "Max users to return", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Offset for pagination", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Sort field: last_activity_at, usage_api, usage_ui, keys_total_count", "type": "text/plain" }, "key": "sort", "value": "last_activity_at" }, { "disabled": false, "description": { "content": "Sort order", "type": "text/plain" }, "key": "sort_order", "value": "desc" }, { "disabled": false, "description": { "content": "Filter by plan code (free/pro)", "type": "text/plain" }, "key": "plan", "value": "" }, { "disabled": false, "description": { "content": "Filter users with API usage", "type": "text/plain" }, "key": "activated_api", "value": "" }, { "disabled": false, "description": { "content": "Filter users with UI usage", "type": "text/plain" }, "key": "activated_ui", "value": "" }, { "disabled": false, "description": { "content": "Filter by email domain", "type": "text/plain" }, "key": "email_domain", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31625681-e936-43ea-8449-2c2f76f23a89", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "users", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Start date (YYYY-MM-DD)", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "End date (YYYY-MM-DD)", "type": "text/plain" }, "key": "to", "value": "" }, { "disabled": false, "description": { "content": "Max users to return", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Offset for pagination", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Sort field: last_activity_at, usage_api, usage_ui, keys_total_count", "type": "text/plain" }, "key": "sort", "value": "last_activity_at" }, { "disabled": false, "description": { "content": "Sort order", "type": "text/plain" }, "key": "sort_order", "value": "desc" }, { "disabled": false, "description": { "content": "Filter by plan code (free/pro)", "type": "text/plain" }, "key": "plan", "value": "" }, { "disabled": false, "description": { "content": "Filter users with API usage", "type": "text/plain" }, "key": "activated_api", "value": "" }, { "disabled": false, "description": { "content": "Filter users with UI usage", "type": "text/plain" }, "key": "activated_ui", "value": "" }, { "disabled": false, "description": { "content": "Filter by email domain", "type": "text/plain" }, "key": "email_domain", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eb0d1c7b-bf4b-47c3-b1e0-fc52cb264253", "name": "Admin Free Api Key Funnel", "request": { "name": "Admin Free Api Key Funnel", "description": {}, "url": { "path": [ "admin", "funnel", "free-api-key" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Start date (YYYY-MM-DD)", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "End date (YYYY-MM-DD)", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7b673f8e-c1f0-4b88-89e8-0c00fa7d1586", "name": "Successful Response", "originalRequest": { "url": { "path": [ "admin", "funnel", "free-api-key" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Start date (YYYY-MM-DD)", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "End date (YYYY-MM-DD)", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3b3acb5-8210-4d9e-adfd-627152eb2928", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "funnel", "free-api-key" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Start date (YYYY-MM-DD)", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "End date (YYYY-MM-DD)", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7210049c-9820-450f-8bce-7001d3d5ea12", "name": "Admin Funnel Events", "request": { "name": "Admin Funnel Events", "description": {}, "url": { "path": [ "admin", "funnel", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by event name", "type": "text/plain" }, "key": "event_name", "value": "" }, { "disabled": false, "description": { "content": "Start date (YYYY-MM-DD)", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "End date (YYYY-MM-DD)", "type": "text/plain" }, "key": "to", "value": "" }, { "disabled": false, "description": { "content": "Filter by email domain", "type": "text/plain" }, "key": "email_domain", "value": "" }, { "disabled": false, "description": { "content": "Max events to return", "type": "text/plain" }, "key": "limit", "value": "200" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "50fd2c63-2292-47db-bbe6-0b8d63b0e74d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "admin", "funnel", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by event name", "type": "text/plain" }, "key": "event_name", "value": "" }, { "disabled": false, "description": { "content": "Start date (YYYY-MM-DD)", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "End date (YYYY-MM-DD)", "type": "text/plain" }, "key": "to", "value": "" }, { "disabled": false, "description": { "content": "Filter by email domain", "type": "text/plain" }, "key": "email_domain", "value": "" }, { "disabled": false, "description": { "content": "Max events to return", "type": "text/plain" }, "key": "limit", "value": "200" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "089ce782-75a3-438c-82fd-f0e31990c6ed", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "funnel", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by event name", "type": "text/plain" }, "key": "event_name", "value": "" }, { "disabled": false, "description": { "content": "Start date (YYYY-MM-DD)", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "End date (YYYY-MM-DD)", "type": "text/plain" }, "key": "to", "value": "" }, { "disabled": false, "description": { "content": "Filter by email domain", "type": "text/plain" }, "key": "email_domain", "value": "" }, { "disabled": false, "description": { "content": "Max events to return", "type": "text/plain" }, "key": "limit", "value": "200" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "46541fa8-1b93-4217-8a61-82075feaaf9f", "name": "Get audit log entries (admin only)", "request": { "name": "Get audit log entries (admin only)", "description": { "content": "Get audit log entries with optional filters.\n\n**Filters**:\n- `user_id`: Filter by user ID\n- `action`: Filter by action (e.g., 'key_create', 'login_success')\n- `status`: Filter by status ('success', 'failure', 'error')\n- `from_date`: Filter from date (YYYY-MM-DD)\n- `to_date`: Filter to date (YYYY-MM-DD)\n\n**Pagination**:\n- `page`: Page number (1-indexed, default: 1)\n- `page_size`: Items per page (default: 50, max: 100)\n\nEntries are ordered by timestamp descending (newest first).", "type": "text/plain" }, "url": { "path": [ "admin", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by user ID", "type": "text/plain" }, "key": "user_id", "value": "" }, { "disabled": false, "description": { "content": "Filter by action type", "type": "text/plain" }, "key": "action", "value": "" }, { "disabled": false, "description": { "content": "Filter by status", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Filter from date (YYYY-MM-DD)", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "Filter to date (YYYY-MM-DD)", "type": "text/plain" }, "key": "to_date", "value": "" }, { "disabled": false, "description": { "content": "Page number (1-indexed)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2e5466b3-cdf7-494a-a930-24312f06093b", "name": "Audit log entries", "originalRequest": { "url": { "path": [ "admin", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by user ID", "type": "text/plain" }, "key": "user_id", "value": "" }, { "disabled": false, "description": { "content": "Filter by action type", "type": "text/plain" }, "key": "action", "value": "" }, { "disabled": false, "description": { "content": "Filter by status", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Filter from date (YYYY-MM-DD)", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "Filter to date (YYYY-MM-DD)", "type": "text/plain" }, "key": "to_date", "value": "" }, { "disabled": false, "description": { "content": "Page number (1-indexed)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"entries\": [\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"action\": \"\",\n \"status\": \"\",\n \"user_id\": \"\",\n \"user_email\": \"\",\n \"ip_address\": \"\",\n \"details\": {},\n \"resource_type\": \"\",\n \"resource_id\": \"\",\n \"error_code\": \"\",\n \"user_agent\": \"\",\n \"latency_ms\": \"\"\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"action\": \"\",\n \"status\": \"\",\n \"user_id\": \"\",\n \"user_email\": \"\",\n \"ip_address\": \"\",\n \"details\": {},\n \"resource_type\": \"\",\n \"resource_id\": \"\",\n \"error_code\": \"\",\n \"user_agent\": \"\",\n \"latency_ms\": \"\"\n }\n ],\n \"total\": \"\",\n \"page\": \"\",\n \"page_size\": \"\",\n \"has_more\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3bb39fd-4fa7-4640-a6e6-649e75182894", "name": "Invalid or missing admin token", "originalRequest": { "url": { "path": [ "admin", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by user ID", "type": "text/plain" }, "key": "user_id", "value": "" }, { "disabled": false, "description": { "content": "Filter by action type", "type": "text/plain" }, "key": "action", "value": "" }, { "disabled": false, "description": { "content": "Filter by status", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Filter from date (YYYY-MM-DD)", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "Filter to date (YYYY-MM-DD)", "type": "text/plain" }, "key": "to_date", "value": "" }, { "disabled": false, "description": { "content": "Page number (1-indexed)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ffef761d-937b-4434-8ff6-e1e7b71706fd", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by user ID", "type": "text/plain" }, "key": "user_id", "value": "" }, { "disabled": false, "description": { "content": "Filter by action type", "type": "text/plain" }, "key": "action", "value": "" }, { "disabled": false, "description": { "content": "Filter by status", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Filter from date (YYYY-MM-DD)", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "Filter to date (YYYY-MM-DD)", "type": "text/plain" }, "key": "to_date", "value": "" }, { "disabled": false, "description": { "content": "Page number (1-indexed)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb33184a-5133-450a-bd02-ef7c5d4408c6", "name": "Database unavailable", "originalRequest": { "url": { "path": [ "admin", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by user ID", "type": "text/plain" }, "key": "user_id", "value": "" }, { "disabled": false, "description": { "content": "Filter by action type", "type": "text/plain" }, "key": "action", "value": "" }, { "disabled": false, "description": { "content": "Filter by status", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Filter from date (YYYY-MM-DD)", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "Filter to date (YYYY-MM-DD)", "type": "text/plain" }, "key": "to_date", "value": "" }, { "disabled": false, "description": { "content": "Page number (1-indexed)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page", "type": "text/plain" }, "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "286b0ae5-98c5-4a75-89f3-05279ca65d91", "name": "Grant beta access bonus quota to a user", "request": { "name": "Grant beta access bonus quota to a user", "description": { "content": "Grant bonus quota to a user for beta access or promotional purposes.\n\n**Required**: Either `email` or `user_id` must be provided.\n\n**Audit**: All grants are logged with the admin identifier and optional note.\n\n**Examples**:\n- Beta tester: 2000 bonus, expires in 30 days\n- Promotional: 500 bonus, no expiration (permanent)", "type": "text/plain" }, "url": { "path": [ "admin", "beta", "grant" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"user_id\": \"\",\n \"kind\": \"integration_pilot\",\n \"bonus_quota\": 0,\n \"expires_at\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "800ab8a7-985e-4dda-b528-fc63c4c54bcd", "name": "Beta bonus granted successfully", "originalRequest": { "url": { "path": [ "admin", "beta", "grant" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"user_id\": \"\",\n \"kind\": \"integration_pilot\",\n \"bonus_quota\": 0,\n \"expires_at\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"user_id\": \"\",\n \"user_email\": \"\",\n \"entitlement_id\": \"\",\n \"bonus_quota\": \"\",\n \"starts_at\": \"\",\n \"effective_quota_preview\": \"\",\n \"expires_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90125027-54c5-4e95-991f-daccc8f91170", "name": "Invalid request (user not found, invalid params)", "originalRequest": { "url": { "path": [ "admin", "beta", "grant" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"user_id\": \"\",\n \"kind\": \"integration_pilot\",\n \"bonus_quota\": 0,\n \"expires_at\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "02f498bd-41fd-4991-9532-0b600015c72b", "name": "Invalid or missing admin token", "originalRequest": { "url": { "path": [ "admin", "beta", "grant" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"user_id\": \"\",\n \"kind\": \"integration_pilot\",\n \"bonus_quota\": 0,\n \"expires_at\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a40bcab1-713f-4f7b-91f3-c06c3c342c63", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "beta", "grant" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"user_id\": \"\",\n \"kind\": \"integration_pilot\",\n \"bonus_quota\": 0,\n \"expires_at\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b4c2052-bbe6-43a7-b4ad-6d20bdbf4d37", "name": "Database unavailable", "originalRequest": { "url": { "path": [ "admin", "beta", "grant" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"user_id\": \"\",\n \"kind\": \"integration_pilot\",\n \"bonus_quota\": 0,\n \"expires_at\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a6ff2166-f810-4a1a-9ce6-444de086515d", "name": "Extend (or shorten) an existing entitlement window", "request": { "name": "Extend (or shorten) an existing entitlement window", "description": { "content": "Move an entitlement's `expires_at` to a new value. Use either:\n - `days`: relative — new expiration = now + N days (default flow:\n \"Prolonger +15 jours\" button on the admin entitlements page)\n - `until`: absolute — new expiration set to the provided UTC ISO 8601 datetime\n (used by the date picker for custom durations like +30 jours pour un gros prospect)\n\nUseful when an ERP integrator needs more time to finish their integration.\nThe new expiration must be strictly after the entitlement's `starts_at`.\nAudit-trail logged with admin actor + previous/new values.", "type": "text/plain" }, "url": { "path": [ "admin", "entitlements", ":entitlement_id", "extend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "entitlement_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"days\": \"\",\n \"until\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d9df15fa-9c32-4bf6-82e3-eea6ab2e240b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "admin", "entitlements", ":entitlement_id", "extend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "entitlement_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"days\": \"\",\n \"until\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"entitlement_id\": \"\",\n \"user_id\": \"\",\n \"kind\": \"\",\n \"new_expires_at\": \"\",\n \"status\": \"ok\",\n \"previous_expires_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c65999ce-09a5-42bd-913a-b1b7d645b4b8", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "entitlements", ":entitlement_id", "extend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "entitlement_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"days\": \"\",\n \"until\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c87a385c-7b06-4650-ae72-dcff0a32621d", "name": "List a user's entitlements", "request": { "name": "List a user's entitlements", "description": { "content": "Get all entitlements (active and expired) for a user.\n\n**user_identifier**: Can be either user_id (UUID) or email address.", "type": "text/plain" }, "url": { "path": [ "admin", "beta", "entitlements", ":user_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "user_identifier", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0dc45ff3-3ac9-457c-b754-9e32e3611b9d", "name": "User entitlements", "originalRequest": { "url": { "path": [ "admin", "beta", "entitlements", ":user_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "user_identifier" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"user_id\": \"\",\n \"user_email\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"kind\": \"\",\n \"bonus_quota\": \"\",\n \"starts_at\": \"\",\n \"is_active\": \"\",\n \"granted_by\": \"\",\n \"created_at\": \"\",\n \"expires_at\": \"\",\n \"note\": \"\"\n },\n {\n \"id\": \"\",\n \"kind\": \"\",\n \"bonus_quota\": \"\",\n \"starts_at\": \"\",\n \"is_active\": \"\",\n \"granted_by\": \"\",\n \"created_at\": \"\",\n \"expires_at\": \"\",\n \"note\": \"\"\n }\n ],\n \"active_bonus_total\": \"\",\n \"nearest_expiration\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c653c59-f8e4-4cee-a4b7-3468092596ee", "name": "User not found", "originalRequest": { "url": { "path": [ "admin", "beta", "entitlements", ":user_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "user_identifier" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eeded7e5-3d67-428c-82c8-49a0c00c03a7", "name": "Invalid or missing admin token", "originalRequest": { "url": { "path": [ "admin", "beta", "entitlements", ":user_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "user_identifier" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "09bd6f83-f059-4821-89ff-d51ef0d1085b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "beta", "entitlements", ":user_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "user_identifier" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae119d70-fee2-44a7-b155-67d616978778", "name": "Database unavailable", "originalRequest": { "url": { "path": [ "admin", "beta", "entitlements", ":user_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "user_identifier" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "52e2f39e-e17d-4a94-bd90-e4847d6e56e3", "name": "Get monetization funnel conversion metrics (admin only)", "request": { "name": "Get monetization funnel conversion metrics (admin only)", "description": { "content": "Get monetization conversion metrics for the quota-to-subscription funnel.\n\n**Metrics tracked:**\n- `quota_80_reached`: Users hitting 80% quota threshold\n- `quota_100_reached`: Users hitting 100% quota threshold\n- `upgrade_email_sent`: Quota warning emails sent\n- `api_upgrade_intent`: API-originated upgrade intents\n- `checkout_session_created`: Stripe checkout sessions initiated\n- `subscription_activated`: Successful Pro subscriptions\n- `quota_exceeded`: Total quota exceeded events\n- `channel_counts`: Split (`api` / `ui` / `unknown`) for checkout and quota events\n- `data_quality`: Missing/mismatch diagnostics for `channel` and `source` metadata\n\n**Time periods:**\n- 7-day metrics (last 7 days)\n- 30-day metrics (last 30 days)\n\n**Conversion rates:**\n- `email_to_checkout_rate`: upgrade_email_sent → checkout_session_created\n- `checkout_to_subscription_rate`: checkout_session_created → subscription_activated\n- `overall_conversion_rate`: quota_exceeded → subscription_activated\n- `api_upgrade_intent_to_checkout_rate`: api_upgrade_intent → checkout_session_created(channel=api)", "type": "text/plain" }, "url": { "path": [ "admin", "monetization" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "33770fef-51e1-4e9f-97a2-eb47e89aa67e", "name": "Monetization conversion metrics", "originalRequest": { "url": { "path": [ "admin", "monetization" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1db28d6f-2006-4211-b976-e65e83aa4fac", "name": "Invalid or missing admin token", "originalRequest": { "url": { "path": [ "admin", "monetization" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9eeebe2f-8bbd-457a-b44b-6301e71a4cae", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "monetization" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8780c2d6-b7e7-4169-964d-5ab4d3063173", "name": "Database unavailable", "originalRequest": { "url": { "path": [ "admin", "monetization" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f6c3faed-92a9-4431-b5a9-09691bb0ccc3", "name": "Send beta access test email (admin only)", "request": { "name": "Send beta access test email (admin only)", "description": { "content": "Send a test beta access email to verify email formatting and delivery.\n\n**Email Template Options:**\n- With `api_key`: Shows the specific API key in the email (for new users)\n- Without `api_key` (empty): Generic template referencing existing API key (for existing users)\n\nThis is useful for testing both email templates and ensuring proper configuration\nbefore sending emails to actual beta users.", "type": "text/plain" }, "url": { "path": [ "admin", "beta", "send-test-email" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Email address to send test to", "type": "text/plain" }, "key": "email", "value": "" }, { "disabled": false, "description": { "content": "Optional API key to show in email. If empty, sends generic template for existing users", "type": "text/plain" }, "key": "api_key", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "a316c0e6-6ee2-4c21-87e8-072ba4e1c1c2", "name": "Test email sent successfully", "originalRequest": { "url": { "path": [ "admin", "beta", "send-test-email" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Email address to send test to", "type": "text/plain" }, "key": "email", "value": "" }, { "disabled": false, "description": { "content": "Optional API key to show in email. If empty, sends generic template for existing users", "type": "text/plain" }, "key": "api_key", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69848a3e-140d-4bba-acd5-39e8b30b3b66", "name": "Invalid or missing admin token", "originalRequest": { "url": { "path": [ "admin", "beta", "send-test-email" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Email address to send test to", "type": "text/plain" }, "key": "email", "value": "" }, { "disabled": false, "description": { "content": "Optional API key to show in email. If empty, sends generic template for existing users", "type": "text/plain" }, "key": "api_key", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e6e54ee9-12cc-40f9-8574-9bdba5360069", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "beta", "send-test-email" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Email address to send test to", "type": "text/plain" }, "key": "email", "value": "" }, { "disabled": false, "description": { "content": "Optional API key to show in email. If empty, sends generic template for existing users", "type": "text/plain" }, "key": "api_key", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec9e8082-ef06-4e41-aed5-9c2c55299138", "name": "Failed to send email", "originalRequest": { "url": { "path": [ "admin", "beta", "send-test-email" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Email address to send test to", "type": "text/plain" }, "key": "email", "value": "" }, { "disabled": false, "description": { "content": "Optional API key to show in email. If empty, sends generic template for existing users", "type": "text/plain" }, "key": "api_key", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "06a926be-f85a-4d91-9a2b-f136857cfa1c", "name": "Validation analytics dashboard", "request": { "name": "Validation analytics dashboard", "description": { "content": "Aggregate validation statistics for product analytics:\n- File type distribution (PDF vs XML)\n- Pass/fail rates\n- Profile distribution\n- Top error codes\n- Source distribution (API vs web)\n- Daily volume trends\n\nData comes from validation_runs table (RGPD-safe, no PII).", "type": "text/plain" }, "url": { "path": [ "admin", "validation", "analytics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Number of days to analyze", "type": "text/plain" }, "key": "days", "value": "30" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "16fe1925-9205-49c6-8175-1faf38ddfa72", "name": "Successful Response", "originalRequest": { "url": { "path": [ "admin", "validation", "analytics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Number of days to analyze", "type": "text/plain" }, "key": "days", "value": "30" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21034f12-9606-4af2-bbe3-f4f09874e5d2", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "validation", "analytics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Number of days to analyze", "type": "text/plain" }, "key": "days", "value": "30" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "455a5cb5-94c2-49c4-898f-45cce9cf5d2f", "name": "Convert analytics dashboard", "request": { "name": "Convert analytics dashboard", "description": { "content": "Aggregate conversion statistics for product analytics:\n- Status distribution (completed/failed/expired)\n- Mode distribution (auto/strict_pdfa3/xml_only)\n- Profile distribution (from result_json)\n- Source type distribution (native_text/scan_ocr/hybrid)\n- Packaging rate (PDF/A-3 generation)\n- Daily volume trends\n- Average duration\n- OCR/cloud usage from budget counters\n\nData comes from convert_jobs + convert_budget_daily_counters (RGPD-safe, no PII).", "type": "text/plain" }, "url": { "path": [ "admin", "convert", "analytics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Number of days to analyze", "type": "text/plain" }, "key": "days", "value": "30" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "961e7449-8282-4c15-869f-70e2f80f9391", "name": "Successful Response", "originalRequest": { "url": { "path": [ "admin", "convert", "analytics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Number of days to analyze", "type": "text/plain" }, "key": "days", "value": "30" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2c5d500-3b2c-4f2e-8cef-02b1892471ce", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "convert", "analytics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Number of days to analyze", "type": "text/plain" }, "key": "days", "value": "30" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f0013faa-eed0-4399-8d3e-74f9004b7d20", "name": "Send Trial Emails", "request": { "name": "Send Trial Emails", "description": { "content": "Find eligible users for a Free or Integration-trial drip stage and send the email.\n\nReplaces the legacy `/send-activation-reminders` endpoint. Each stage has its own\nSQL eligibility window (see `_TRIAL_STAGE_WINDOWS`) and is idempotent via the\n`funnel_events` table (event name `trial_email_{stage}`).\n\nPilot users (`integration_pilot` entitlement) and paid users are NEVER targeted —\nthey have dedicated channels.", "type": "text/plain" }, "url": { "path": [ "admin", "send-trial-emails" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Drip stage to process", "type": "text/plain" }, "key": "stage", "value": "trial_j12_remaining" }, { "disabled": false, "description": { "content": "If true, return eligible users without sending", "type": "text/plain" }, "key": "dry_run", "value": "true" }, { "disabled": false, "description": { "content": "Max emails to send per call", "type": "text/plain" }, "key": "max_send", "value": "50" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "7fa838e3-0811-4a68-bde4-fdc1b80374c2", "name": "Successful Response", "originalRequest": { "url": { "path": [ "admin", "send-trial-emails" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Drip stage to process", "type": "text/plain" }, "key": "stage", "value": "trial_j12_remaining" }, { "disabled": false, "description": { "content": "If true, return eligible users without sending", "type": "text/plain" }, "key": "dry_run", "value": "true" }, { "disabled": false, "description": { "content": "Max emails to send per call", "type": "text/plain" }, "key": "max_send", "value": "50" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "394b8c2e-7b10-417f-bf8d-eeed0221ad66", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "send-trial-emails" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Drip stage to process", "type": "text/plain" }, "key": "stage", "value": "trial_j12_remaining" }, { "disabled": false, "description": { "content": "If true, return eligible users without sending", "type": "text/plain" }, "key": "dry_run", "value": "true" }, { "disabled": false, "description": { "content": "Max emails to send per call", "type": "text/plain" }, "key": "max_send", "value": "50" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aba6c1ef-e4fe-4298-9f76-aa31509c2ce8", "name": "Send Credit Announcement", "request": { "name": "Send Credit Announcement", "description": { "content": "Send credit pack announcement to specific users.\n\nTiers:\n- personalized: for high-intent business users (recent, exhausted)\n- informative: for business users (moderate usage)\n- generic: for personal email users (high usage)\n\nDry run by default. Set dry_run=false to send.", "type": "text/plain" }, "url": { "path": [ "admin", "send-credit-announcement" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) List of recipient emails", "type": "text/plain" }, "key": "emails", "value": "" }, { "disabled": false, "description": { "content": "(Required) List of recipient emails", "type": "text/plain" }, "key": "emails", "value": "" }, { "disabled": false, "description": { "content": "Email tier: personalized, informative, generic", "type": "text/plain" }, "key": "tier", "value": "generic" }, { "disabled": false, "description": { "content": "If true, show what would be sent without sending", "type": "text/plain" }, "key": "dry_run", "value": "true" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "46d3f8fe-32d7-4f1c-97ed-a7782675de9b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "admin", "send-credit-announcement" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) List of recipient emails", "type": "text/plain" }, "key": "emails", "value": "" }, { "disabled": false, "description": { "content": "Email tier: personalized, informative, generic", "type": "text/plain" }, "key": "tier", "value": "generic" }, { "disabled": false, "description": { "content": "If true, show what would be sent without sending", "type": "text/plain" }, "key": "dry_run", "value": "true" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e51a2de-4260-4666-856e-a152cbb6696c", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "send-credit-announcement" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) List of recipient emails", "type": "text/plain" }, "key": "emails", "value": "" }, { "disabled": false, "description": { "content": "Email tier: personalized, informative, generic", "type": "text/plain" }, "key": "tier", "value": "generic" }, { "disabled": false, "description": { "content": "If true, show what would be sent without sending", "type": "text/plain" }, "key": "dry_run", "value": "true" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "admin-stripe", "description": "", "item": [ { "id": "387f404d-6d9a-43d6-9eef-d55c881d9aa3", "name": "List failed Stripe events", "request": { "name": "List failed Stripe events", "description": { "content": "Get a list of Stripe events that failed processing and can be replayed.", "type": "text/plain" }, "url": { "path": [ "admin", "stripe", "failed-events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9a77fb59-60cf-4ed3-a035-654a3b3e40d0", "name": "Successful Response", "originalRequest": { "url": { "path": [ "admin", "stripe", "failed-events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"events\": [\n {\n \"record_id\": \"\",\n \"event_id\": \"\",\n \"event_type\": \"\",\n \"stripe_id\": \"\",\n \"user_id\": \"\",\n \"api_key_id\": \"\",\n \"processed_at\": \"\",\n \"status\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"error_details\": \"\"\n },\n {\n \"record_id\": \"\",\n \"event_id\": \"\",\n \"event_type\": \"\",\n \"stripe_id\": \"\",\n \"user_id\": \"\",\n \"api_key_id\": \"\",\n \"processed_at\": \"\",\n \"status\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"error_details\": \"\"\n }\n ],\n \"count\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07e3035b-0464-41a5-b1da-c759c47db267", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "stripe", "failed-events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e830f72-c323-4700-bc46-7e1f21d180ca", "name": "List Stripe events", "request": { "name": "List Stripe events", "description": { "content": "Get a list of recent Stripe events with optional filters.", "type": "text/plain" }, "url": { "path": [ "admin", "stripe", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "event_type", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ca964000-1cab-4ffd-9909-03dd39454a3e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "admin", "stripe", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "event_type", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"events\": [\n {\n \"record_id\": \"\",\n \"event_id\": \"\",\n \"event_type\": \"\",\n \"stripe_id\": \"\",\n \"user_id\": \"\",\n \"api_key_id\": \"\",\n \"processed_at\": \"\",\n \"status\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"error_details\": \"\"\n },\n {\n \"record_id\": \"\",\n \"event_id\": \"\",\n \"event_type\": \"\",\n \"stripe_id\": \"\",\n \"user_id\": \"\",\n \"api_key_id\": \"\",\n \"processed_at\": \"\",\n \"status\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"error_details\": \"\"\n }\n ],\n \"count\": \"\",\n \"last_webhook_received_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "891840e6-30db-4780-999b-f2cd6ff8e3d4", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "stripe", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "event_type", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "64542d9f-9c10-4de2-98cd-232607a383ba", "name": "Subscription health dashboard", "request": { "name": "Subscription health dashboard", "description": { "content": "Live view of all Stripe subscriptions with status, renewal dates, and payment info.", "type": "text/plain" }, "url": { "path": [ "admin", "stripe", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1cb3ff4d-8606-49c4-b1df-5b79e64b83bb", "name": "Successful Response", "originalRequest": { "url": { "path": [ "admin", "stripe", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96fc7553-212c-4ea2-ba86-577698fdce4b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "stripe", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ccd66b5a-8818-4b37-8ea0-2e669d9b456c", "name": "Replay a failed Stripe event", "request": { "name": "Replay a failed Stripe event", "description": { "content": "DISABLED: Replay functionality requires storing original Stripe payloads.", "type": "text/plain" }, "url": { "path": [ "admin", "stripe", "replay-event" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "3972ed80-b6b5-4dd8-a66b-481bda7c8b40", "name": "Successful Response", "originalRequest": { "url": { "path": [ "admin", "stripe", "replay-event" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19ac6f90-fa8b-48f6-b761-04a54fb46b81", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "stripe", "replay-event" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5c56e2e2-5325-4f55-9cce-992a9a077de4", "name": "Replay all failed Stripe events", "request": { "name": "Replay all failed Stripe events", "description": { "content": "DISABLED: Replay functionality requires storing original Stripe payloads.", "type": "text/plain" }, "url": { "path": [ "admin", "stripe", "replay-all-failed" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "566503d2-8faa-4794-b62b-895b92bd59c3", "name": "Successful Response", "originalRequest": { "url": { "path": [ "admin", "stripe", "replay-all-failed" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82c46e36-aa0a-433f-8a9f-ea251c76f909", "name": "Validation Error", "originalRequest": { "url": { "path": [ "admin", "stripe", "replay-all-failed" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-admin-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "validation", "description": "", "item": [ { "id": "702ba871-8588-4a63-8d6f-5c046f921b34", "name": "Valider une facture Factur-X", "request": { "name": "Valider une facture Factur-X", "description": { "content": "Valide une facture électronique au format **Factur-X** (PDF ou XML).\n\n## 🔐 Authentification\n\nCet endpoint supporte trois méthodes d'authentification :\n\n1. **JWT Dashboard** : `Authorization: Bearer ` (utilisateurs connectés)\n2. **API Key** : `X-API-Key: ` ou `Authorization: Bearer ` (clients externes)\n3. **Refresh Token** : Cookie `refresh_token` (renouvellement automatique)\n\n## 📥 Formats supportés\n\n- **PDF Factur-X** : PDF avec XML embarqué conforme EN16931\n- **XML standalone** : Fichier XML Factur-X seul\n\n## ✅ Validations effectuées\n\n1. **Validation PDF/A-3** : Vérifie la conformité PDF/A-3 (si PDF)\n2. **Validation structure Factur-X** : Vérifie les pièces jointes et métadonnées XMP (si PDF)\n3. **Validation XSD** : Vérifie la structure XML contre le schéma XSD\n4. **Validation Schematron** : Vérifie les règles métier EN16931\n\n## 📤 Réponses possibles\n\n### Succès (200 OK) - Format unifié (par défaut)\n```json\n{\n \"valid\": true,\n \"validatedAt\": \"2025-12-27T12:23:51.676602+00:00\",\n \"filename\": \"invoice.xml\",\n \"profile\": \"EN16931\",\n \"durationMs\": 124,\n \"summary\": { \"errorCount\": 0, \"warningCount\": 0 },\n \"issues\": [],\n \"stages\": {\n \"pdfa\": { \"passed\": true, \"skipped\": true, \"skip_reason\": \"XML file - PDF/A validation not applicable\", \"error_count\": 0, \"warning_count\": 0, \"info_count\": 0, \"issues\": [] },\n \"facturx_pdf\": { \"passed\": true, \"skipped\": true, \"skip_reason\": \"XML file - PDF checks not applicable\", \"error_count\": 0, \"warning_count\": 0, \"info_count\": 0, \"issues\": [] },\n \"xsd\": { \"passed\": true, \"skipped\": false, \"skip_reason\": null, \"error_count\": 0, \"warning_count\": 0, \"info_count\": 0, \"issues\": [] },\n \"schematron\": { \"passed\": true, \"skipped\": false, \"skip_reason\": null, \"error_count\": 0, \"warning_count\": 0, \"info_count\": 0, \"issues\": [] }\n },\n \"errors\": [],\n \"warnings\": []\n}\n```\n\n### Succès (200 OK) - Format legacy (?legacy=true)\n```json\n{\n \"valid\": true,\n \"errors\": [],\n \"warnings\": [],\n \"profile\": \"EN16931\",\n \"message\": \"Validation completed\"\n}\n```\n\n### Validation échouée (200 OK avec valid=false)\n```json\n{\n \"valid\": false,\n \"validatedAt\": \"2025-12-27T12:23:51.676602+00:00\",\n \"filename\": \"invoice.xml\",\n \"profile\": \"EN16931\",\n \"durationMs\": 124,\n \"summary\": { \"errorCount\": 1, \"warningCount\": 0 },\n \"issues\": [\n {\n \"code\": \"XSD_VALIDATION_ERROR\",\n \"severity\": \"error\",\n \"stage\": \"xsd\",\n \"message\": \"Missing required element: InvoiceNumber\",\n \"line\": 42,\n \"expected\": \"InvoiceNumber\",\n \"actual\": null,\n \"location\": \"line 42\",\n \"ruleId\": null,\n \"xpath\": \"/Invoice/ID\"\n }\n ],\n \"stages\": {\n \"pdfa\": { \"passed\": true, \"skipped\": true, \"skip_reason\": \"XML file - PDF/A validation not applicable\", \"error_count\": 0, \"warning_count\": 0, \"info_count\": 0, \"issues\": [] },\n \"facturx_pdf\": { \"passed\": true, \"skipped\": true, \"skip_reason\": \"XML file - PDF checks not applicable\", \"error_count\": 0, \"warning_count\": 0, \"info_count\": 0, \"issues\": [] },\n \"xsd\": { \"passed\": false, \"skipped\": false, \"skip_reason\": null, \"error_count\": 1, \"warning_count\": 0, \"info_count\": 0, \"issues\": [] },\n \"schematron\": { \"passed\": true, \"skipped\": false, \"skip_reason\": null, \"error_count\": 0, \"warning_count\": 0, \"info_count\": 0, \"issues\": [] }\n },\n \"errors\": [],\n \"warnings\": []\n}\n```\n\n### Erreur fichier vide (400 Bad Request)\n```json\n{\n \"detail\": \"Empty file\"\n}\n```\n\n## 🌍 Internationalisation\n\nUtilisez le header **Accept-Language** pour obtenir les messages en français:\n- `Accept-Language: en` (par défaut)\n- `Accept-Language: fr`\n\n## 💾 Stockage\n\nLe fichier est stocké temporairement sur R2/stockage local pour traçabilité.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "validate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "legacy", "value": "false" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header if not specified.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Fichier XML ou PDF Factur-X à valider (limite configurable via MAX_UPLOAD_SIZE_BYTES)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] }, "auth": null }, "response": [ { "id": "66bc2213-80f6-4aaa-95a0-cdf6ae586e2d", "name": "Validation effectuée (succès ou échec)", "originalRequest": { "url": { "path": [ "api", "v1", "validate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "legacy", "value": "false" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header if not specified.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Fichier XML ou PDF Factur-X à valider (limite configurable via MAX_UPLOAD_SIZE_BYTES)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"valid\": \"\",\n \"errors\": [\n {\n \"key_0\": \"\"\n },\n {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\"\n }\n ],\n \"warnings\": [\n {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n ],\n \"profile\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18eb561a-a29d-4cb3-9932-0cc173f564ac", "name": "Fichier vide ou invalide", "originalRequest": { "url": { "path": [ "api", "v1", "validate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "legacy", "value": "false" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header if not specified.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Fichier XML ou PDF Factur-X à valider (limite configurable via MAX_UPLOAD_SIZE_BYTES)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "32d58049-0c6a-464d-9c28-abc236309436", "name": "Quota dépassé (quota_exceeded)", "originalRequest": { "url": { "path": [ "api", "v1", "validate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "legacy", "value": "false" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header if not specified.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Fichier XML ou PDF Factur-X à valider (limite configurable via MAX_UPLOAD_SIZE_BYTES)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Payment Required", "code": 402, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f4872c3a-b0ff-4283-ad8a-2080c423d82a", "name": "Fichier trop volumineux (file_too_large)", "originalRequest": { "url": { "path": [ "api", "v1", "validate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "legacy", "value": "false" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header if not specified.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Fichier XML ou PDF Factur-X à valider (limite configurable via MAX_UPLOAD_SIZE_BYTES)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Request Entity Too Large", "code": 413, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e406df6a-b2ae-4ce1-b500-087a1f0f67ba", "name": "Type de fichier non supporté (unsupported_media_type)", "originalRequest": { "url": { "path": [ "api", "v1", "validate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "legacy", "value": "false" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header if not specified.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Fichier XML ou PDF Factur-X à valider (limite configurable via MAX_UPLOAD_SIZE_BYTES)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cf50a845-99c4-4a10-a289-f0352f8afe99", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "validate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "legacy", "value": "false" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header if not specified.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Fichier XML ou PDF Factur-X à valider (limite configurable via MAX_UPLOAD_SIZE_BYTES)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa019e9e-2028-4f37-b313-749ab2db4369", "name": "Rate limit dépassé (rate_limit_exceeded)", "originalRequest": { "url": { "path": [ "api", "v1", "validate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "legacy", "value": "false" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header if not specified.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Fichier XML ou PDF Factur-X à valider (limite configurable via MAX_UPLOAD_SIZE_BYTES)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Too Many Requests", "code": 429, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0be6fde6-4767-4287-998b-bb9c44bdb641", "name": "Erreur serveur (stockage, traitement)", "originalRequest": { "url": { "path": [ "api", "v1", "validate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "legacy", "value": "false" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header if not specified.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Fichier XML ou PDF Factur-X à valider (limite configurable via MAX_UPLOAD_SIZE_BYTES)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2091e40c-f8b2-42af-8091-be92aa3a0cbc", "name": "Validation engine indisponible (service_unavailable)", "originalRequest": { "url": { "path": [ "api", "v1", "validate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "legacy", "value": "false" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header if not specified.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Fichier XML ou PDF Factur-X à valider (limite configurable via MAX_UPLOAD_SIZE_BYTES)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Service Unavailable", "code": 503, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "extract", "description": "", "item": [ { "id": "25f7a70c-3c4a-47a1-b05a-169d3e7f09b3", "name": "Extract Factur-X XML from PDF", "request": { "name": "Extract Factur-X XML from PDF", "description": { "content": "Extracts the embedded Factur-X XML from a PDF file.\n\n## Features\n\n1. **XML Extraction**: Extracts the embedded XML attachment from Factur-X PDFs\n2. **Profile Detection**: Automatically detects the Factur-X profile (MINIMUM, BASIC_WL, BASIC, EN16931, EXTENDED)\n3. **Optional Validation**: Validates the extracted XML against XSD/Schematron rules\n\n## Authentication\n\nRequires authentication via:\n- `X-API-Key: ` header, OR\n- `Authorization: Bearer ` header\n\n## Query Parameters\n\n- `validate=true`: Run full validation on extracted XML (doubles quota usage)\n- `lang=en|fr`: Language for response messages\n\n## Response\n\nReturns base64-encoded extracted XML with metadata:\n- `xml`: Base64-encoded XML content\n- `xmlSize`: Size of XML in bytes\n- `profile`: Detected Factur-X profile\n- `durationMs`: Extraction time in milliseconds\n- `validation`: Optional validation report (if validate=true)\n\n## Quota Usage\n\n- Default: 1 unit\n- With `validate=true`: 2 units", "type": "text/plain" }, "url": { "path": [ "api", "v1", "extract" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Run validation after extraction (2x quota)", "type": "text/plain" }, "key": "validate", "value": "false" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to extract XML from (Factur-X format)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] }, "auth": null }, "response": [ { "id": "282dda3b-2897-4cc7-b75f-1206294d0be2", "name": "XML extracted successfully", "originalRequest": { "url": { "path": [ "api", "v1", "extract" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Run validation after extraction (2x quota)", "type": "text/plain" }, "key": "validate", "value": "false" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to extract XML from (Factur-X format)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60ee6ded-5ee3-4f2d-ad8f-d14757467048", "name": "Invalid request", "originalRequest": { "url": { "path": [ "api", "v1", "extract" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Run validation after extraction (2x quota)", "type": "text/plain" }, "key": "validate", "value": "false" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to extract XML from (Factur-X format)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab01ea8d-93c9-44de-ab67-3b2e1c8d37c9", "name": "Authentication required", "originalRequest": { "url": { "path": [ "api", "v1", "extract" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Run validation after extraction (2x quota)", "type": "text/plain" }, "key": "validate", "value": "false" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to extract XML from (Factur-X format)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30ca8413-0104-4680-9a7f-ad774e21d498", "name": "Quota exceeded", "originalRequest": { "url": { "path": [ "api", "v1", "extract" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Run validation after extraction (2x quota)", "type": "text/plain" }, "key": "validate", "value": "false" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to extract XML from (Factur-X format)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Payment Required", "code": 402, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "79fa2954-7e5c-4e74-95c5-d2cbd4e660b8", "name": "File too large", "originalRequest": { "url": { "path": [ "api", "v1", "extract" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Run validation after extraction (2x quota)", "type": "text/plain" }, "key": "validate", "value": "false" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to extract XML from (Factur-X format)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Request Entity Too Large", "code": 413, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3c22137a-0653-49d4-a92b-b4cea8a9cd6f", "name": "Unsupported media type (non-PDF file)", "originalRequest": { "url": { "path": [ "api", "v1", "extract" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Run validation after extraction (2x quota)", "type": "text/plain" }, "key": "validate", "value": "false" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to extract XML from (Factur-X format)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9a3332e1-d0a1-42d8-af31-219a93ee3a03", "name": "PDF without Factur-X XML", "originalRequest": { "url": { "path": [ "api", "v1", "extract" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Run validation after extraction (2x quota)", "type": "text/plain" }, "key": "validate", "value": "false" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to extract XML from (Factur-X format)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e576404-bb4c-4226-b61f-ae5a829175cc", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "api", "v1", "extract" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Run validation after extraction (2x quota)", "type": "text/plain" }, "key": "validate", "value": "false" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to extract XML from (Factur-X format)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0906724f-53df-48d2-b045-d67360ab3974", "name": "Service unavailable", "originalRequest": { "url": { "path": [ "api", "v1", "extract" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Run validation after extraction (2x quota)", "type": "text/plain" }, "key": "validate", "value": "false" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to extract XML from (Factur-X format)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Service Unavailable", "code": 503, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "repair", "description": "", "item": [ { "id": "77c6d9d1-758c-43b6-a51d-fbe492ceedab", "name": "Repair Factur-X XML", "request": { "name": "Repair Factur-X XML", "description": { "content": "Repairs a Factur-X XML file to fix common EN16931 validation issues.\n\n## Three-Phase Workflow\n\n1. **Validate BEFORE**: Capture the initial validation state\n2. **Apply Repairs**: Apply deterministic repair rules\n3. **Validate AFTER**: Verify that repairs improved validity\n\n## Repair Rules Applied\n\n- **R001**: Date format correction (YYYY-MM-DD -> YYYYMMDD)\n- **R002**: Decimal format correction (comma -> dot separator)\n- **R005**: Namespace prefix/URI fixes\n- **R006**: Required schemeID attributes\n- **R007**: Currency code casing (eur -> EUR)\n- **R008**: Missing required elements (constraint-gated)\n\n## Authentication\n\nRequires authentication via:\n- `X-API-Key: ` header, OR\n- `Authorization: Bearer ` header\n\n## Idempotency\n\nUse `Idempotency-Key` header to ensure safe retries:\n- Same key + same payload = same response (cached)\n- Same key + different payload = 409 Conflict\n\n## Constraints\n\nControl repair behavior via the `constraints` form field (JSON):\n```json\n{\n \"max_changes_allowed\": 10,\n \"do_not_modify_amounts\": true,\n \"do_not_invent_missing_parties\": true,\n \"target_profile\": \"EN16931\"\n}\n```\n\n## Response\n\nReturns base64-encoded repaired XML with before/after validation reports\nand a diff summary of all changes made.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "repair" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Target Factur-X profile for repair. If not specified, auto-detected from XML.", "type": "text/plain" }, "key": "target_profile", "value": "MINIMUM" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Idempotency key for safe retries (recommended for production use)", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) XML file to repair (Factur-X/EN16931 format)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "constraints", "value": "", "type": "text" } ] }, "auth": null }, "response": [ { "id": "2aff462b-2b2f-4201-8889-fbe61cc06cc5", "name": "XML repaired successfully", "originalRequest": { "url": { "path": [ "api", "v1", "repair" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Target Factur-X profile for repair. If not specified, auto-detected from XML.", "type": "text/plain" }, "key": "target_profile", "value": "MINIMUM" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Idempotency key for safe retries (recommended for production use)", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) XML file to repair (Factur-X/EN16931 format)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "constraints", "value": "", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3799bf89-ffe0-4657-bcdc-7cb728db7949", "name": "Invalid request", "originalRequest": { "url": { "path": [ "api", "v1", "repair" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Target Factur-X profile for repair. If not specified, auto-detected from XML.", "type": "text/plain" }, "key": "target_profile", "value": "MINIMUM" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Idempotency key for safe retries (recommended for production use)", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) XML file to repair (Factur-X/EN16931 format)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "constraints", "value": "", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be907e5a-3236-465a-9512-a7eeedfbeaf3", "name": "Quota exceeded", "originalRequest": { "url": { "path": [ "api", "v1", "repair" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Target Factur-X profile for repair. If not specified, auto-detected from XML.", "type": "text/plain" }, "key": "target_profile", "value": "MINIMUM" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Idempotency key for safe retries (recommended for production use)", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) XML file to repair (Factur-X/EN16931 format)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "constraints", "value": "", "type": "text" } ] } }, "status": "Payment Required", "code": 402, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "539f59bd-cfb0-4969-9a96-e038ba125dc1", "name": "Idempotency conflict", "originalRequest": { "url": { "path": [ "api", "v1", "repair" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Target Factur-X profile for repair. If not specified, auto-detected from XML.", "type": "text/plain" }, "key": "target_profile", "value": "MINIMUM" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Idempotency key for safe retries (recommended for production use)", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) XML file to repair (Factur-X/EN16931 format)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "constraints", "value": "", "type": "text" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "527dc044-c5b7-44f8-8fd0-28e2a698871a", "name": "File too large", "originalRequest": { "url": { "path": [ "api", "v1", "repair" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Target Factur-X profile for repair. If not specified, auto-detected from XML.", "type": "text/plain" }, "key": "target_profile", "value": "MINIMUM" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Idempotency key for safe retries (recommended for production use)", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) XML file to repair (Factur-X/EN16931 format)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "constraints", "value": "", "type": "text" } ] } }, "status": "Request Entity Too Large", "code": 413, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e249eefe-e69d-4285-991d-8942298601cd", "name": "Unsupported media type (non-XML file)", "originalRequest": { "url": { "path": [ "api", "v1", "repair" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Target Factur-X profile for repair. If not specified, auto-detected from XML.", "type": "text/plain" }, "key": "target_profile", "value": "MINIMUM" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Idempotency key for safe retries (recommended for production use)", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) XML file to repair (Factur-X/EN16931 format)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "constraints", "value": "", "type": "text" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eef4468b-77c8-43a7-8815-9adff85ec7a7", "name": "Unprocessable entity", "originalRequest": { "url": { "path": [ "api", "v1", "repair" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Target Factur-X profile for repair. If not specified, auto-detected from XML.", "type": "text/plain" }, "key": "target_profile", "value": "MINIMUM" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Idempotency key for safe retries (recommended for production use)", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) XML file to repair (Factur-X/EN16931 format)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "constraints", "value": "", "type": "text" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e257fadf-199c-47b3-86d3-570a8a0260d6", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "api", "v1", "repair" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Target Factur-X profile for repair. If not specified, auto-detected from XML.", "type": "text/plain" }, "key": "target_profile", "value": "MINIMUM" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Idempotency key for safe retries (recommended for production use)", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) XML file to repair (Factur-X/EN16931 format)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "constraints", "value": "", "type": "text" } ] } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53ef3a85-86e9-4e79-9716-61d118b8004d", "name": "Service unavailable", "originalRequest": { "url": { "path": [ "api", "v1", "repair" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Target Factur-X profile for repair. If not specified, auto-detected from XML.", "type": "text/plain" }, "key": "target_profile", "value": "MINIMUM" }, { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Idempotency key for safe retries (recommended for production use)", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) XML file to repair (Factur-X/EN16931 format)", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "constraints", "value": "", "type": "text" } ] } }, "status": "Service Unavailable", "code": 503, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "convert", "description": "", "item": [ { "id": "819fc50c-d4eb-40a0-9d20-558ef31256c7", "name": "Analyze PDF before conversion (no credits consumed)", "request": { "name": "Analyze PDF before conversion (no credits consumed)", "description": { "content": "Lightweight pre-conversion analysis: validates the PDF, detects scan/native text,\ncounts pages, and estimates the credit cost — **without consuming any credits**.\n\nUse this before `/convert` to show users what will happen and how much it will cost.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "convert", "analyze" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to analyze before conversion", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] }, "auth": null }, "response": [ { "id": "b6c7ef3c-341b-491e-a6e8-ef671517d8c2", "name": "Analysis result with cost estimate", "originalRequest": { "url": { "path": [ "api", "v1", "convert", "analyze" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to analyze before conversion", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da705bac-97e9-4295-bb8f-2dad8b6c91c5", "name": "Invalid request (empty file)", "originalRequest": { "url": { "path": [ "api", "v1", "convert", "analyze" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to analyze before conversion", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "364a381c-ea83-47e4-aadb-b1b8bba5961f", "name": "Authentication required", "originalRequest": { "url": { "path": [ "api", "v1", "convert", "analyze" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to analyze before conversion", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "86f21974-6d56-40f6-a670-2b88f128b625", "name": "File too large", "originalRequest": { "url": { "path": [ "api", "v1", "convert", "analyze" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to analyze before conversion", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Request Entity Too Large", "code": 413, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5f757790-716f-4b00-94ec-ed5c24c015d6", "name": "Unsupported file type (not PDF)", "originalRequest": { "url": { "path": [ "api", "v1", "convert", "analyze" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to analyze before conversion", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f834c552-2d92-4d6c-bae9-831aa800857e", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "convert", "analyze" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to analyze before conversion", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ccfa256-4d61-4ab2-b015-4eb2e67f97fc", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "api", "v1", "convert", "analyze" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to analyze before conversion", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Too Many Requests", "code": 429, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9bb004cf-6919-408a-904f-c20b2986fc00", "name": "Convert PDF to Factur-X PDF/A-3", "request": { "name": "Convert PDF to Factur-X PDF/A-3", "description": { "content": "Converts a PDF invoice to a Factur-X compliant PDF/A-3 document.\n\n## Conversion Workflow\n\n1. **Scan Detection**: Determines if PDF is native text or scanned image\n2. **Data Extraction**: Extracts invoice data (text parsing or OCR)\n3. **XML Generation**: Creates EN16931-compliant Factur-X XML\n4. **PDF/A-3 Generation**: Embeds XML into PDF/A-3 format\n5. **Validation**: Validates the complete Factur-X document\n\n## Authentication\n\nRequires authentication via:\n- `X-API-Key: ` header, OR\n- `Authorization: Bearer ` header\n\n## Idempotency\n\nUse `Idempotency-Key` header to ensure safe retries:\n- Same key + same payload = same response (cached)\n- Same key + different payload = 409 Conflict\n\n## Options\n\nControl conversion behavior via the `options` form field (JSON):\n```json\n{\n \"output_profile\": \"EN16931\",\n \"lang\": \"en\",\n \"confidence_mode\": \"strict\",\n \"seller_hint\": \"FR\",\n \"buyer_hint\": \"DE\"\n}\n```\n\n### Confidence Mode\n- `strict` (default): Reject OCR results with confidence < 70%\n- `lenient`: Accept low confidence with warning in response\n\n## Response\n\nReturns the generated Factur-X PDF/A-3 with embedded XML and validation report.\nPDF is base64-encoded in the response. Use the `xml` field for the embedded XML.\n\n## Quota Usage\n\n- Native text PDF: 5 units\n- Scanned PDF (OCR): 5-15 units based on page count", "type": "text/plain" }, "url": { "path": [ "api", "v1", "convert" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Idempotency key for safe retries (recommended for production use)", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to convert to Factur-X format", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "options", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "invoice_data", "value": "", "type": "text" } ] }, "auth": null }, "response": [ { "id": "9ad0a069-6f19-488b-81b8-9e057b72464f", "name": "PDF converted successfully", "originalRequest": { "url": { "path": [ "api", "v1", "convert" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Idempotency key for safe retries (recommended for production use)", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to convert to Factur-X format", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "options", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "invoice_data", "value": "", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6eab585-eea4-4aeb-a567-5262e8e0f615", "name": "Conversion accepted for async processing", "originalRequest": { "url": { "path": [ "api", "v1", "convert" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Idempotency key for safe retries (recommended for production use)", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to convert to Factur-X format", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "options", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "invoice_data", "value": "", "type": "text" } ] } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0588821d-05b6-4e8b-a3be-aad8317e54bc", "name": "Invalid request", "originalRequest": { "url": { "path": [ "api", "v1", "convert" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Idempotency key for safe retries (recommended for production use)", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to convert to Factur-X format", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "options", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "invoice_data", "value": "", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0aece07e-ff32-4879-bb6a-8ddb523cfe3d", "name": "Authentication required", "originalRequest": { "url": { "path": [ "api", "v1", "convert" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Idempotency key for safe retries (recommended for production use)", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to convert to Factur-X format", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "options", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "invoice_data", "value": "", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4c76c1b-5da6-498e-9bae-0cc3ca6a2bc5", "name": "Quota exceeded", "originalRequest": { "url": { "path": [ "api", "v1", "convert" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Idempotency key for safe retries (recommended for production use)", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to convert to Factur-X format", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "options", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "invoice_data", "value": "", "type": "text" } ] } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6a288a1-2264-417b-9c73-888c95ebe40c", "name": "Idempotency conflict", "originalRequest": { "url": { "path": [ "api", "v1", "convert" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Idempotency key for safe retries (recommended for production use)", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to convert to Factur-X format", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "options", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "invoice_data", "value": "", "type": "text" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a6b7bb7-a112-42d1-aa30-51efb1819489", "name": "File too large", "originalRequest": { "url": { "path": [ "api", "v1", "convert" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Idempotency key for safe retries (recommended for production use)", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to convert to Factur-X format", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "options", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "invoice_data", "value": "", "type": "text" } ] } }, "status": "Request Entity Too Large", "code": 413, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eda3c679-3e6b-4d01-8987-d372e6d3f4de", "name": "Unsupported media type (non-PDF file)", "originalRequest": { "url": { "path": [ "api", "v1", "convert" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Idempotency key for safe retries (recommended for production use)", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to convert to Factur-X format", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "options", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "invoice_data", "value": "", "type": "text" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6870bf17-8397-435f-b6fd-fdf8195238ae", "name": "Unprocessable entity", "originalRequest": { "url": { "path": [ "api", "v1", "convert" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Idempotency key for safe retries (recommended for production use)", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to convert to Factur-X format", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "options", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "invoice_data", "value": "", "type": "text" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36578dce-1792-47ad-9dfc-6f83829f3674", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "api", "v1", "convert" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Idempotency key for safe retries (recommended for production use)", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to convert to Factur-X format", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "options", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "invoice_data", "value": "", "type": "text" } ] } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71c41708-3edf-4b9b-980b-490f7aec8706", "name": "Service unavailable (OCR or PDF generation)", "originalRequest": { "url": { "path": [ "api", "v1", "convert" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Idempotency key for safe retries (recommended for production use)", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to convert to Factur-X format", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "options", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "invoice_data", "value": "", "type": "text" } ] } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5f7b737-9c39-4668-97bf-0b71e530f28a", "name": "Timeout (OCR or PDF generation)", "originalRequest": { "url": { "path": [ "api", "v1", "convert" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Response language (en or fr). Falls back to Accept-Language header.", "type": "text/plain" }, "key": "lang", "value": "fr" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Idempotency key for safe retries (recommended for production use)", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) PDF file to convert to Factur-X format", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "options", "value": "", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "invoice_data", "value": "", "type": "text" } ] } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "49850368-ca6e-4d37-bc8a-cc92cd34d275", "name": "Get convert job status", "request": { "name": "Get convert job status", "description": { "content": "Get status/result for a convert async job.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "convert", "jobs", ":job_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "job_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "84434b59-1fe1-4b62-a630-d0350410a2b5", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "convert", "jobs", ":job_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "job_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51444972-3689-4c2f-afe6-4c46321d1d10", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "convert", "jobs", ":job_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "job_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e89289d3-fdcc-453e-8e1c-84f7462094d6", "name": "Get signed URL for convert job artifact", "request": { "name": "Get signed URL for convert job artifact", "description": { "content": "Return signed download URL for a completed convert job artifact.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "convert", "jobs", ":job_id", "artifacts", ":artifact_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "job_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "artifact_name", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d2148055-5103-41e6-9411-1235cfaa0198", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "convert", "jobs", ":job_id", "artifacts", ":artifact_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "job_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "artifact_name" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35030262-ebf2-4968-9afd-eb24e10e5058", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "convert", "jobs", ":job_id", "artifacts", ":artifact_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "job_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "artifact_name" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ddeef6ba-1b21-4f01-abb5-619bdb2c9bcb", "name": "Cancel convert job", "request": { "name": "Cancel convert job", "description": { "content": "Cancel a queued/running convert job.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "convert", "jobs", ":job_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "job_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "4b143b69-932f-49ba-9fbc-8292c198df3d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "convert", "jobs", ":job_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "job_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52398a4d-eb44-4d53-a883-1ebd87a196d5", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "convert", "jobs", ":job_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "job_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "webhooks", "description": "", "item": [ { "id": "1d700406-96a5-43e8-b0fd-b88f2290e57b", "name": "Stripe Webhook V1", "request": { "name": "Stripe Webhook V1", "description": { "content": "Handle Stripe webhook events (API v1 endpoint).\n\nMain webhook endpoint for Stripe events.\nAvailable at: POST /api/v1/webhooks/stripe", "type": "text/plain" }, "url": { "path": [ "api", "v1", "webhooks", "stripe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Stripe-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "b0a953f7-4eff-438e-8f87-2e1bdbb086a3", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", "stripe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Stripe-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "424f7e93-4569-4c81-8c43-a10b3ad4a046", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", "stripe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Stripe-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "webhooks-legacy", "description": "", "item": [ { "id": "15f92a21-d67c-4e94-b284-4801363c06af", "name": "Stripe Webhook Legacy", "request": { "name": "Stripe Webhook Legacy", "description": { "content": "Handle Stripe webhook events (legacy endpoint).\n\nLegacy webhook endpoint maintained for backward compatibility.\nAvailable at: POST /webhooks/stripe\n\nNOTE: This endpoint is deprecated. Use /api/v1/webhooks/stripe instead.", "type": "text/plain" }, "url": { "path": [ "webhooks", "stripe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Stripe-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "a5fde2be-31d7-426f-8beb-3fecd34d2269", "name": "Successful Response", "originalRequest": { "url": { "path": [ "webhooks", "stripe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Stripe-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e6e15a4-7c9c-4a28-bc7c-b75732de6eda", "name": "Validation Error", "originalRequest": { "url": { "path": [ "webhooks", "stripe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Stripe-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "public", "description": "", "item": [ { "id": "92faab97-49bd-4eca-a592-5b480de61b3b", "name": "Request a free API key (Step 1)", "request": { "name": "Request a free API key (Step 1)", "description": { "content": "Request a free API key for an email address.\n\n## Behavior depends on server configuration:\n\n### When email verification is ENABLED (default):\n**Step 1 of 2**: This endpoint sends a verification token to your email.\nUse the token with `POST /public/api-keys/free/step2` to complete the process.\n\n- **Uniform response**: Same response whether email is new, has a key, or is invalid\n (prevents email enumeration attacks)\n- **Token expiry**: Verification tokens expire after 30 minutes\n- **Rate limiting**: 5 requests/hour, 10 requests/day per IP\n\n### When email verification is DISABLED:\n**Single step**: This endpoint immediately creates and returns your API key.\n\n- **Warning**: Returns 409 if email already has a key (reveals email existence)\n- **Use case**: Internal/trusted environments only\n- The `/free/step2` endpoint is not needed in this mode\n\n**Important**: Save the returned API key immediately - it cannot be retrieved later!", "type": "text/plain" }, "url": { "path": [ "public", "api-keys", "free", "step1" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"label\": \"\",\n \"source\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d53e374a-af20-4472-9a0d-5760623057cd", "name": "Success - either verification requested (2-step mode) or API key created (immediate mode)", "originalRequest": { "url": { "path": [ "public", "api-keys", "free", "step1" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"label\": \"\",\n \"source\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"email\": \"\",\n \"expires_in_seconds\": \"\",\n \"message\": \"If this email is valid, a verification code has been sent. Check your inbox and use POST /public/api-keys/free/step2 to complete.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "455442c2-d3a4-499c-af78-76d24ce6e278", "name": "Email already has an active API key (only in immediate mode)", "originalRequest": { "url": { "path": [ "public", "api-keys", "free", "step1" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"label\": \"\",\n \"source\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96164787-62ce-4285-a818-84661cf10ff5", "name": "Invalid email address", "originalRequest": { "url": { "path": [ "public", "api-keys", "free", "step1" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"label\": \"\",\n \"source\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": \"invalid_email\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb41e2b6-c656-43e5-9eef-5b7d232d16fa", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "public", "api-keys", "free", "step1" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"label\": \"\",\n \"source\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": {\n \"retry_after_seconds\": \"\",\n \"error\": \"rate_limit_exceeded\",\n \"message\": \"Too many requests. Please try again later.\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98f4fdbc-ea71-4be7-aea6-79009296b8bc", "name": "Server configuration error", "originalRequest": { "url": { "path": [ "public", "api-keys", "free", "step1" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"label\": \"\",\n \"source\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7628f61d-8ca5-4963-bbd3-79624c5148e2", "name": "Email service unavailable (only in 2-step mode)", "originalRequest": { "url": { "path": [ "public", "api-keys", "free", "step1" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"label\": \"\",\n \"source\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ca0acfb3-e333-47b2-b624-68d0fb807707", "name": "Confirm and create API key (Step 2)", "request": { "name": "Confirm and create API key (Step 2)", "description": { "content": "**Step 2 of 2**: Confirm your email and receive your API key.\n\nUse the verification token from your email to complete the API key creation.\n\n## Important\n\n- The API key is returned **ONLY ONCE**. Save it immediately!\n- If you already have an active API key, you'll receive an error.\n- Tokens expire after 30 minutes.\n- If email verification is disabled on this server, returns 400 \"verification_not_required\".", "type": "text/plain" }, "url": { "path": [ "public", "api-keys", "free", "step2" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"token\": \"\",\n \"regenerate\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f05df691-d087-44c6-8269-73fb9834b8b3", "name": "API key created successfully", "originalRequest": { "url": { "path": [ "public", "api-keys", "free", "step2" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"token\": \"\",\n \"regenerate\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"email\": \"\",\n \"apiKey\": \"\",\n \"plan\": {\n \"code\": \"\",\n \"monthly_quota\": \"\"\n },\n \"createdAt\": \"\",\n \"message\": \"API key created successfully. Save it now - it cannot be retrieved later!\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "941b44a8-4abf-4c6b-a658-af9bfbe463d2", "name": "Invalid or expired token, or verification not required", "originalRequest": { "url": { "path": [ "public", "api-keys", "free", "step2" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"token\": \"\",\n \"regenerate\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2590e6fd-1717-454c-a2f8-62dbce92abdb", "name": "Email already has an active API key", "originalRequest": { "url": { "path": [ "public", "api-keys", "free", "step2" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"token\": \"\",\n \"regenerate\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": \"email_already_has_active_key\",\n \"error_code\": \"email_already_has_active_key\",\n \"message_human\": \"Une clé API gratuite est déjà active pour cet email.\",\n \"next_steps\": [\n {\n \"label\": \"\",\n \"href\": \"\",\n \"action\": \"\"\n },\n {\n \"label\": \"\",\n \"href\": \"\",\n \"action\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aabfea58-f4b5-4c37-a2eb-51461f147472", "name": "Invalid request", "originalRequest": { "url": { "path": [ "public", "api-keys", "free", "step2" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"token\": \"\",\n \"regenerate\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": \"invalid_email\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b51fe7c4-e64b-471f-8291-13619d1b892e", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "public", "api-keys", "free", "step2" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"token\": \"\",\n \"regenerate\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": {\n \"retry_after_seconds\": \"\",\n \"error\": \"rate_limit_exceeded\",\n \"message\": \"Too many requests. Please try again later.\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb4984d9-1b9f-437e-8c2c-449fa18827e2", "name": "Server configuration error", "originalRequest": { "url": { "path": [ "public", "api-keys", "free", "step2" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"token\": \"\",\n \"regenerate\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "314ada5e-b74a-4aa6-b893-1336ad2df365", "name": "Service unavailable", "originalRequest": { "url": { "path": [ "public", "api-keys", "free", "step2" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"token\": \"\",\n \"regenerate\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0aa469c6-a0ed-4dba-b39a-6c55eb61dde5", "name": "Activate the 15-day Integration trial for an existing Free user", "request": { "name": "Activate the 15-day Integration trial for an existing Free user", "description": { "content": "One-click upgrade endpoint hit by the Free J+7 upsell email (`/api-key?source=upgrade_from_free&email=...&activate_trial=true`). Idempotent: returns 409 if the user already has an active trial. Does not require auth — the magic-link-style activation is bound to the email pre-baked in our own outbound email.", "type": "text/plain" }, "url": { "path": [ "public", "api-keys", "upgrade-trial" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a14fc0c5-cac5-4e75-877d-fbfa4a639cdd", "name": "Successful Response", "originalRequest": { "url": { "path": [ "public", "api-keys", "upgrade-trial" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"email\": \"\",\n \"bonus_quota\": \"\",\n \"expires_at\": \"\",\n \"message\": \"Essai Integration activé. Vos 100 opérations sont disponibles.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53f2cc87-6784-49ec-8f4c-f2531cdd6a8f", "name": "User not found or no active Free key", "originalRequest": { "url": { "path": [ "public", "api-keys", "upgrade-trial" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "94e48b96-06e7-4c4f-994a-08cc86614c56", "name": "Trial already active for this user", "originalRequest": { "url": { "path": [ "public", "api-keys", "upgrade-trial" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0bc1127b-f927-4d30-ac8c-ed7139ef4113", "name": "Invalid email", "originalRequest": { "url": { "path": [ "public", "api-keys", "upgrade-trial" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8ad29674-7d95-4664-95e8-711a027b90da", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "public", "api-keys", "upgrade-trial" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "796b1fb7-a6ae-477e-96e4-8d77016f90cf", "name": "Service unavailable", "originalRequest": { "url": { "path": [ "public", "api-keys", "upgrade-trial" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "meta", "description": "", "item": [ { "id": "9af9f101-bdb7-437e-a075-c942955b07ee", "name": "Public metadata (source of truth)", "request": { "name": "Public metadata (source of truth)", "description": { "content": "Public, read-only metadata used as a single source of truth for versions, artefacts, limits, and plan quotas.", "type": "text/plain" }, "url": { "path": [ "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2e197d14-ed16-455f-9199-4dfd5106af2e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"build\": {\n \"commit_sha\": \"\",\n \"build_date\": \"\",\n \"env\": \"\"\n },\n \"validation_engine\": {\n \"artifacts\": [\n {\n \"kind\": \"\",\n \"path\": \"\",\n \"sha256\": \"\",\n \"size_bytes\": \"\",\n \"version_declared\": \"\",\n \"version_detected\": \"\",\n \"origin\": \"\"\n },\n {\n \"kind\": \"\",\n \"path\": \"\",\n \"sha256\": \"\",\n \"size_bytes\": \"\",\n \"version_declared\": \"\",\n \"version_detected\": \"\",\n \"origin\": \"\"\n }\n ],\n \"pdfa\": {\n \"provider\": \"\",\n \"configured\": \"\",\n \"version\": \"\"\n }\n },\n \"limits\": {\n \"max_upload_size_bytes\": \"\",\n \"accepted_formats\": [\n \"\",\n \"\"\n ],\n \"rate_limit_enabled\": \"\",\n \"rate_limit_requests_per_minute\": \"\",\n \"rate_limit_mode\": \"\"\n },\n \"capabilities\": {\n \"supports_facturx_108_xsd\": \"\",\n \"supports_en16931_compiled_xslt\": \"\",\n \"supports_pdfa_via_verapdf\": \"\",\n \"facturx_108_schematron_guaranteed\": \"\",\n \"supports_extract\": true,\n \"supports_repair\": false,\n \"supports_convert\": false\n },\n \"links\": {\n \"generated_at\": \"\",\n \"docs\": \"\",\n \"openapi\": \"\",\n \"changelog\": \"\",\n \"status\": \"\"\n },\n \"plans\": [\n {\n \"code\": \"\",\n \"name\": \"\",\n \"monthly_quota\": \"\",\n \"price\": \"\"\n },\n {\n \"code\": \"\",\n \"name\": \"\",\n \"monthly_quota\": \"\",\n \"price\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "invoicing-issuer", "description": "", "item": [ { "id": "6540ea76-fdbc-42a1-ab35-6ba974d2a5a4", "name": "Upsert Issuer", "request": { "name": "Upsert Issuer", "description": { "content": "Create or update the issuer profile.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "issuer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"siret\": \"12703192246835\",\n \"vat_regime\": \"FRANCHISE_293B\",\n \"address_line1\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"country_code\": \"FR\",\n \"legal_form\": \"\",\n \"vat_number\": \"\",\n \"address_line2\": \"\",\n \"iban\": \"\",\n \"bic\": \"\",\n \"capital\": \"\",\n \"rcs_city\": \"\",\n \"numbering_prefix\": \"F\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5462fa61-0dce-47cc-acba-440f69c83471", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "issuer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"siret\": \"12703192246835\",\n \"vat_regime\": \"FRANCHISE_293B\",\n \"address_line1\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"country_code\": \"FR\",\n \"legal_form\": \"\",\n \"vat_number\": \"\",\n \"address_line2\": \"\",\n \"iban\": \"\",\n \"bic\": \"\",\n \"capital\": \"\",\n \"rcs_city\": \"\",\n \"numbering_prefix\": \"F\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"siret\": \"\",\n \"vat_regime\": \"\",\n \"address_line1\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"country_code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"legal_form\": \"\",\n \"vat_number\": \"\",\n \"address_line2\": \"\",\n \"iban\": \"\",\n \"bic\": \"\",\n \"capital\": \"\",\n \"rcs_city\": \"\",\n \"numbering_prefix\": \"F\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d0047aa-f600-4dcf-b42f-991931cc0a3a", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "issuer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"siret\": \"12703192246835\",\n \"vat_regime\": \"FRANCHISE_293B\",\n \"address_line1\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"country_code\": \"FR\",\n \"legal_form\": \"\",\n \"vat_number\": \"\",\n \"address_line2\": \"\",\n \"iban\": \"\",\n \"bic\": \"\",\n \"capital\": \"\",\n \"rcs_city\": \"\",\n \"numbering_prefix\": \"F\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "adef296c-83c3-4287-8a53-c9d643a2293c", "name": "Get Issuer", "request": { "name": "Get Issuer", "description": { "content": "Get the current user's issuer profile.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "issuer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "fb4bfd53-228e-49d5-9f86-1f941a3e526a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "issuer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"siret\": \"\",\n \"vat_regime\": \"\",\n \"address_line1\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"country_code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"legal_form\": \"\",\n \"vat_number\": \"\",\n \"address_line2\": \"\",\n \"iban\": \"\",\n \"bic\": \"\",\n \"capital\": \"\",\n \"rcs_city\": \"\",\n \"numbering_prefix\": \"F\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8171135f-1f4d-42b6-b91c-5a94b239f1d2", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "issuer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "invoicing-clients", "description": "", "item": [ { "id": "24def610-2d35-4720-922b-5037cbab32ef", "name": "Create Client", "request": { "name": "Create Client", "description": { "content": "Create a new client.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "clients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"address_line1\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"type\": \"B2B\",\n \"country_code\": \"FR\",\n \"siret\": \"61526127273863\",\n \"vat_number\": \"\",\n \"address_line2\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "74e384ba-a1bc-44a2-9561-9e606f9f7dfd", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "clients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"address_line1\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"type\": \"B2B\",\n \"country_code\": \"FR\",\n \"siret\": \"61526127273863\",\n \"vat_number\": \"\",\n \"address_line2\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"address_line1\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"country_code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"siret\": \"\",\n \"vat_number\": \"\",\n \"address_line2\": \"\",\n \"email\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4eb6c2d-6c13-4158-9bd7-d3d5f6571bac", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "clients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"address_line1\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"type\": \"B2B\",\n \"country_code\": \"FR\",\n \"siret\": \"61526127273863\",\n \"vat_number\": \"\",\n \"address_line2\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cc7ee7d2-f498-4d4d-9744-e25d340a19b3", "name": "List Clients", "request": { "name": "List Clients", "description": { "content": "List all clients for the current user.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "clients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f5a1a024-4a8d-4945-a36d-bcee746aa818", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "clients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"clients\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"address_line1\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"country_code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"siret\": \"\",\n \"vat_number\": \"\",\n \"address_line2\": \"\",\n \"email\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"address_line1\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"country_code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"siret\": \"\",\n \"vat_number\": \"\",\n \"address_line2\": \"\",\n \"email\": \"\"\n }\n ],\n \"total\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd8394fb-40a1-4229-b9ff-bf36f87a586f", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "clients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4bbba269-2576-46b7-b335-404a496cf80d", "name": "Get Client", "request": { "name": "Get Client", "description": { "content": "Get a client by ID.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "clients", ":client_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "client_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "bf01ee40-1e44-4e79-ab4f-93d3289c521c", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "clients", ":client_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "client_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"address_line1\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"country_code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"siret\": \"\",\n \"vat_number\": \"\",\n \"address_line2\": \"\",\n \"email\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c7aa0ed-2a09-4646-8f3d-fb4bdc1c0722", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "clients", ":client_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "client_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "17f5d03e-ec56-4a7c-b41c-72900b4a5560", "name": "Update Client", "request": { "name": "Update Client", "description": { "content": "Update a client.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "clients", ":client_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "client_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"address_line1\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"type\": \"B2B\",\n \"country_code\": \"FR\",\n \"siret\": \"61526127273863\",\n \"vat_number\": \"\",\n \"address_line2\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "161131ac-6497-403b-af94-53003a9c0574", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "clients", ":client_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "client_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"address_line1\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"type\": \"B2B\",\n \"country_code\": \"FR\",\n \"siret\": \"61526127273863\",\n \"vat_number\": \"\",\n \"address_line2\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"address_line1\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"country_code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"siret\": \"\",\n \"vat_number\": \"\",\n \"address_line2\": \"\",\n \"email\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14c558f3-3c9f-458f-9677-6b4bfb95f653", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "clients", ":client_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "client_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"address_line1\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"type\": \"B2B\",\n \"country_code\": \"FR\",\n \"siret\": \"61526127273863\",\n \"vat_number\": \"\",\n \"address_line2\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4b29de90-6690-44d6-a3b1-ffd0dbd470bc", "name": "Delete Client", "request": { "name": "Delete Client", "description": { "content": "Delete a client.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "clients", ":client_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "client_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "e41f135f-020b-45b4-a3ae-74f91ae241e1", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "clients", ":client_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "client_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "21fa369c-02f0-412d-891b-436aac22e4b5", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "clients", ":client_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "client_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "invoicing-invoices", "description": "", "item": [ { "id": "b9f8f2cc-300b-4828-8e00-c70da4842211", "name": "Check Invoicing Access", "request": { "name": "Check Invoicing Access", "description": { "content": "Check if the current user has invoicing beta access.\n\nReturns {\"has_access\": true/false}. Used by the frontend to show/hide\nthe invoicing navigation section. Does NOT raise 403.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "invoices", "access-check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "63ecd0fd-2777-41c4-80bc-bd7bf2c3b2a1", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "invoices", "access-check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97dc080d-b9e4-4a5a-992c-c5c9fb21784a", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "invoices", "access-check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9a4e0861-4e6e-4b10-adb1-11880b2028ba", "name": "Create Invoice", "request": { "name": "Create Invoice", "description": { "content": "Create a new draft invoice with lines.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"client_id\": \"\",\n \"lines\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"unit_price_ht\": \"\",\n \"vat_rate\": \"\",\n \"vat_category\": \"E\"\n }\n ],\n \"service_date\": \"2815-47-62\",\n \"payment_terms_days\": 30,\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "bd757b88-bd50-430a-acc3-ef0ddcb8719b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"client_id\": \"\",\n \"lines\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"unit_price_ht\": \"\",\n \"vat_rate\": \"\",\n \"vat_category\": \"E\"\n }\n ],\n \"service_date\": \"2815-47-62\",\n \"payment_terms_days\": 30,\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"client_id\": \"\",\n \"currency\": \"\",\n \"total_ht\": \"\",\n \"total_tax\": \"\",\n \"total_ttc\": \"\",\n \"payment_terms_days\": \"\",\n \"facturx_profile\": \"\",\n \"has_pdf\": \"\",\n \"lines\": [\n {\n \"id\": \"\",\n \"position\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"unit_price_ht\": \"\",\n \"vat_rate\": \"\",\n \"vat_category\": \"\",\n \"line_total_ht\": \"\",\n \"line_total_tax\": \"\"\n },\n {\n \"id\": \"\",\n \"position\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"unit_price_ht\": \"\",\n \"vat_rate\": \"\",\n \"vat_category\": \"\",\n \"line_total_ht\": \"\",\n \"line_total_tax\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"invoice_number\": \"\",\n \"client_name\": \"\",\n \"issue_date\": \"\",\n \"service_date\": \"\",\n \"due_date\": \"\",\n \"notes\": \"\",\n \"related_invoice_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49424b90-53d2-43e7-affd-406e69797d9b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"client_id\": \"\",\n \"lines\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"unit_price_ht\": \"\",\n \"vat_rate\": \"\",\n \"vat_category\": \"E\"\n }\n ],\n \"service_date\": \"2815-47-62\",\n \"payment_terms_days\": 30,\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4ac2ec63-d0a7-4b20-aab1-1b14f2369ca0", "name": "List Invoices", "request": { "name": "List Invoices", "description": { "content": "List invoices for the current user.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "invoice_status", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "37032529-8a74-4499-98fc-70363ab8459b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "invoice_status", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"invoices\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"client_id\": \"\",\n \"total_ht\": \"\",\n \"total_ttc\": \"\",\n \"has_pdf\": \"\",\n \"created_at\": \"\",\n \"invoice_number\": \"\",\n \"client_name\": \"\",\n \"issue_date\": \"\",\n \"due_date\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"client_id\": \"\",\n \"total_ht\": \"\",\n \"total_ttc\": \"\",\n \"has_pdf\": \"\",\n \"created_at\": \"\",\n \"invoice_number\": \"\",\n \"client_name\": \"\",\n \"issue_date\": \"\",\n \"due_date\": \"\"\n }\n ],\n \"total\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7955ad4-702f-4da4-9054-f55b534bcb25", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "invoice_status", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6c455d7c-6e97-449b-9f3d-9e93c833eea9", "name": "Get Invoice", "request": { "name": "Get Invoice", "description": { "content": "Get an invoice with lines.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "invoices", ":invoice_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "invoice_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "55b77f44-4cf8-491b-abc6-f2ad9bc85d05", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "invoices", ":invoice_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "invoice_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"client_id\": \"\",\n \"currency\": \"\",\n \"total_ht\": \"\",\n \"total_tax\": \"\",\n \"total_ttc\": \"\",\n \"payment_terms_days\": \"\",\n \"facturx_profile\": \"\",\n \"has_pdf\": \"\",\n \"lines\": [\n {\n \"id\": \"\",\n \"position\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"unit_price_ht\": \"\",\n \"vat_rate\": \"\",\n \"vat_category\": \"\",\n \"line_total_ht\": \"\",\n \"line_total_tax\": \"\"\n },\n {\n \"id\": \"\",\n \"position\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"unit_price_ht\": \"\",\n \"vat_rate\": \"\",\n \"vat_category\": \"\",\n \"line_total_ht\": \"\",\n \"line_total_tax\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"invoice_number\": \"\",\n \"client_name\": \"\",\n \"issue_date\": \"\",\n \"service_date\": \"\",\n \"due_date\": \"\",\n \"notes\": \"\",\n \"related_invoice_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a98a0ef3-7860-41ca-993d-289a77181ad4", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "invoices", ":invoice_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "invoice_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a188da5a-5085-4998-9d01-4934e3a45dbc", "name": "Update Invoice", "request": { "name": "Update Invoice", "description": { "content": "Update a draft invoice. Rejects if not DRAFT.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "invoices", ":invoice_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "invoice_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"client_id\": \"\",\n \"lines\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"unit_price_ht\": \"\",\n \"vat_rate\": \"\",\n \"vat_category\": \"E\"\n },\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"unit_price_ht\": \"\",\n \"vat_rate\": \"\",\n \"vat_category\": \"E\"\n }\n ],\n \"service_date\": \"7963-42-20\",\n \"payment_terms_days\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "cb920137-ace6-479e-b530-3b906a9d48b9", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "invoices", ":invoice_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "invoice_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"client_id\": \"\",\n \"lines\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"unit_price_ht\": \"\",\n \"vat_rate\": \"\",\n \"vat_category\": \"E\"\n },\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"unit_price_ht\": \"\",\n \"vat_rate\": \"\",\n \"vat_category\": \"E\"\n }\n ],\n \"service_date\": \"7963-42-20\",\n \"payment_terms_days\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"client_id\": \"\",\n \"currency\": \"\",\n \"total_ht\": \"\",\n \"total_tax\": \"\",\n \"total_ttc\": \"\",\n \"payment_terms_days\": \"\",\n \"facturx_profile\": \"\",\n \"has_pdf\": \"\",\n \"lines\": [\n {\n \"id\": \"\",\n \"position\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"unit_price_ht\": \"\",\n \"vat_rate\": \"\",\n \"vat_category\": \"\",\n \"line_total_ht\": \"\",\n \"line_total_tax\": \"\"\n },\n {\n \"id\": \"\",\n \"position\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"unit_price_ht\": \"\",\n \"vat_rate\": \"\",\n \"vat_category\": \"\",\n \"line_total_ht\": \"\",\n \"line_total_tax\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"invoice_number\": \"\",\n \"client_name\": \"\",\n \"issue_date\": \"\",\n \"service_date\": \"\",\n \"due_date\": \"\",\n \"notes\": \"\",\n \"related_invoice_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54b842e4-38a4-45f4-a7b6-ffa56cefa98a", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "invoices", ":invoice_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "invoice_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"client_id\": \"\",\n \"lines\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"unit_price_ht\": \"\",\n \"vat_rate\": \"\",\n \"vat_category\": \"E\"\n },\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"unit_price_ht\": \"\",\n \"vat_rate\": \"\",\n \"vat_category\": \"E\"\n }\n ],\n \"service_date\": \"7963-42-20\",\n \"payment_terms_days\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f054c0f2-276b-4b27-9d88-1fd8dce52450", "name": "Issue Invoice", "request": { "name": "Issue Invoice", "description": { "content": "Issue a draft invoice — generates Factur-X PDF/A-3, assigns number.\n\nThis is the point of no return. The invoice becomes immutable.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "invoices", ":invoice_id", "issue" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "invoice_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "dde144fa-da1e-4fb7-a1ab-39bbcf471983", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "invoices", ":invoice_id", "issue" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "invoice_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"invoice_id\": \"\",\n \"invoice_number\": \"\",\n \"pdf_storage_key\": \"\",\n \"total_ht\": \"\",\n \"total_tax\": \"\",\n \"total_ttc\": \"\",\n \"status\": \"ISSUED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d090b629-763e-495e-93fb-29c5ee28e123", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "invoices", ":invoice_id", "issue" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "invoice_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "56bad9cc-525d-41c8-9c35-f92b8ac26b98", "name": "Download Pdf", "request": { "name": "Download Pdf", "description": { "content": "Download the issued invoice as Factur-X PDF.\n\nFor M1, re-generates the PDF on the fly (no R2 storage yet).", "type": "text/plain" }, "url": { "path": [ "api", "v1", "invoices", ":invoice_id", "pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "invoice_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e7f8ee8f-f66c-4857-a154-a1774f4df8d8", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "invoices", ":invoice_id", "pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "invoice_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fde8099-b434-4e10-a3b2-01b5aaf7dc91", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "invoices", ":invoice_id", "pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "invoice_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "269c5508-b428-4a9c-bd1d-af116a446806", "name": "Preview Invoice", "request": { "name": "Preview Invoice", "description": { "content": "Generate a draft PDF preview (with BROUILLON watermark, no number).", "type": "text/plain" }, "url": { "path": [ "api", "v1", "invoices", ":invoice_id", "preview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "invoice_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "18905296-08d2-4a5c-b407-f3d2c39e93d0", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "invoices", ":invoice_id", "preview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "invoice_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cac4b4d-e376-4fcd-a704-fadd20c38918", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "invoices", ":invoice_id", "preview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "invoice_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e394e5b3-d65e-4b80-bd4b-846c4acb2e2e", "name": "Mark Paid", "request": { "name": "Mark Paid", "description": { "content": "Mark an issued invoice as paid.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "invoices", ":invoice_id", "paid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "invoice_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"paid_at\": \"5476-61-52\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6ebd20ad-4da0-44e5-ad99-c2d05223ac8b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "invoices", ":invoice_id", "paid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "invoice_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"paid_at\": \"5476-61-52\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"client_id\": \"\",\n \"currency\": \"\",\n \"total_ht\": \"\",\n \"total_tax\": \"\",\n \"total_ttc\": \"\",\n \"payment_terms_days\": \"\",\n \"facturx_profile\": \"\",\n \"has_pdf\": \"\",\n \"lines\": [\n {\n \"id\": \"\",\n \"position\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"unit_price_ht\": \"\",\n \"vat_rate\": \"\",\n \"vat_category\": \"\",\n \"line_total_ht\": \"\",\n \"line_total_tax\": \"\"\n },\n {\n \"id\": \"\",\n \"position\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"unit_price_ht\": \"\",\n \"vat_rate\": \"\",\n \"vat_category\": \"\",\n \"line_total_ht\": \"\",\n \"line_total_tax\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"invoice_number\": \"\",\n \"client_name\": \"\",\n \"issue_date\": \"\",\n \"service_date\": \"\",\n \"due_date\": \"\",\n \"notes\": \"\",\n \"related_invoice_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac8e69af-efc8-4bbe-988e-24f578d6b067", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "invoices", ":invoice_id", "paid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "invoice_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"paid_at\": \"5476-61-52\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9ff828d4-770f-4760-a8dc-fa73eced329f", "name": "Create Credit Note", "request": { "name": "Create Credit Note", "description": { "content": "Create a credit note (avoir) linked to an issued invoice.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "invoices", ":invoice_id", "credit-note" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "invoice_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"lines\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"unit_price_ht\": \"\",\n \"vat_rate\": \"\",\n \"vat_category\": \"E\"\n }\n ],\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "36ec1542-f5d2-4d9b-b578-2dd5a6681856", "name": "Successful Response", "originalRequest": { "url": { "path": [ "api", "v1", "invoices", ":invoice_id", "credit-note" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "invoice_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"lines\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"unit_price_ht\": \"\",\n \"vat_rate\": \"\",\n \"vat_category\": \"E\"\n }\n ],\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"client_id\": \"\",\n \"currency\": \"\",\n \"total_ht\": \"\",\n \"total_tax\": \"\",\n \"total_ttc\": \"\",\n \"payment_terms_days\": \"\",\n \"facturx_profile\": \"\",\n \"has_pdf\": \"\",\n \"lines\": [\n {\n \"id\": \"\",\n \"position\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"unit_price_ht\": \"\",\n \"vat_rate\": \"\",\n \"vat_category\": \"\",\n \"line_total_ht\": \"\",\n \"line_total_tax\": \"\"\n },\n {\n \"id\": \"\",\n \"position\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"unit_price_ht\": \"\",\n \"vat_rate\": \"\",\n \"vat_category\": \"\",\n \"line_total_ht\": \"\",\n \"line_total_tax\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"invoice_number\": \"\",\n \"client_name\": \"\",\n \"issue_date\": \"\",\n \"service_date\": \"\",\n \"due_date\": \"\",\n \"notes\": \"\",\n \"related_invoice_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "650b0e0e-427d-48f4-8832-d11e70c4265b", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "invoices", ":invoice_id", "credit-note" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "invoice_id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"lines\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"unit_price_ht\": \"\",\n \"vat_rate\": \"\",\n \"vat_category\": \"E\"\n }\n ],\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "pay", "description": "", "item": [ { "id": "8487b368-591e-4122-b591-5dc8bfee6efa", "name": "Get payment page data (public, HMAC-secured)", "request": { "name": "Get payment page data (public, HMAC-secured)", "description": { "content": "Public endpoint consumed by the Astro SSR payment page.\n\n**Security**: HMAC-SHA256(invoice_id, PAYMENT_TOKEN_SECRET) == t\n- Resolves by invoice UUID (globally unique — no cross-tenant collision).\n- Returns 404 for any failure — no distinction to prevent information leaks.\n- DRAFT invoices are not accessible via the public payment page.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "internal", "pay", ":invoice_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "t", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "invoice_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "19d1c74a-f13d-452b-bcc7-bf83753ad35c", "name": "Payment page data", "originalRequest": { "url": { "path": [ "api", "v1", "internal", "pay", ":invoice_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "t", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "invoice_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"issuer_name\": \"\",\n \"issuer_siret\": \"\",\n \"invoice_number\": \"\",\n \"issue_date\": \"\",\n \"due_date\": \"\",\n \"status\": \"\",\n \"total_ht\": \"\",\n \"total_tax\": \"\",\n \"total_ttc\": \"\",\n \"paid_amount\": \"\",\n \"remaining_amount\": \"\",\n \"lines\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"unit_price_ht\": \"\",\n \"line_total_ht\": \"\"\n },\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"unit_price_ht\": \"\",\n \"line_total_ht\": \"\"\n }\n ],\n \"iban\": \"\",\n \"bic\": \"\",\n \"payment_ref\": \"\",\n \"epc_qr_data_uri\": \"\",\n \"pdf_available\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "727dd60c-383b-48a2-a708-a894f5ba836d", "name": "Not found (invalid/missing token, unknown invoice, or DRAFT)", "originalRequest": { "url": { "path": [ "api", "v1", "internal", "pay", ":invoice_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "t", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "invoice_id" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "874c3859-3aa6-401c-8637-471c64ffa9db", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "internal", "pay", ":invoice_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "t", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "invoice_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "28721208-45cf-494f-b806-bbb94b778417", "name": "Record payment analytics event (public, HMAC-secured)", "request": { "name": "Record payment analytics event (public, HMAC-secured)", "description": {}, "url": { "path": [ "api", "v1", "internal", "pay", ":invoice_id", "event" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "t", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "invoice_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "89530e85-d012-4ada-83d2-279036b5f189", "name": "Event recorded", "originalRequest": { "url": { "path": [ "api", "v1", "internal", "pay", ":invoice_id", "event" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "t", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "invoice_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ea7054dc-7169-46d4-8b9d-7b3662155620", "name": "Not found (invalid or missing token)", "originalRequest": { "url": { "path": [ "api", "v1", "internal", "pay", ":invoice_id", "event" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "t", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "invoice_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "21da092b-1c34-474f-9e2c-0dbb2a83b9af", "name": "Unknown event type", "originalRequest": { "url": { "path": [ "api", "v1", "internal", "pay", ":invoice_id", "event" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "t", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "invoice_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3fa32830-1227-48fd-9bd1-0a9b66906717", "name": "Download invoice PDF (public, HMAC-secured)", "request": { "name": "Download invoice PDF (public, HMAC-secured)", "description": { "content": "Download the issued Factur-X PDF via the payment page.\nHMAC-secured: no user auth required.\n\nThe PDF is rebuilt from frozen snapshots (issuer_snapshot, client_snapshot) — it\nalways matches the document as-issued, never live post-issuance data.\nReturns 404 if snapshots are absent to preserve document integrity.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "internal", "pay", ":invoice_id", "pdf" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "t", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "invoice_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c02196b4-676a-44d9-9f4f-111c5b11cbea", "name": "Factur-X PDF/A-3 document", "originalRequest": { "url": { "path": [ "api", "v1", "internal", "pay", ":invoice_id", "pdf" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "t", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "invoice_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42b831a1-e145-489e-a1ac-f4d3e747f6fe", "name": "Not found (invalid token, draft, or snapshot absent)", "originalRequest": { "url": { "path": [ "api", "v1", "internal", "pay", ":invoice_id", "pdf" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "t", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "invoice_id" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ab0a97e3-dc6b-4d50-96f0-e4557f497540", "name": "Validation Error", "originalRequest": { "url": { "path": [ "api", "v1", "internal", "pay", ":invoice_id", "pdf" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "t", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "invoice_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "auth", "description": "", "item": [ { "id": "c01a9232-e730-433b-b2b4-4c523eed0754", "name": "Request a magic link for authentication", "request": { "name": "Request a magic link for authentication", "description": { "content": "Request a magic link to be sent to your email address.\n\n## Security\n- **Rate limited**: 5 requests/hour, 10 requests/day per IP\n- **Uniform response**: Same response whether email exists or not (prevents enumeration)\n- **Token expiry**: Magic links expire after 15 minutes\n\n## Flow\n1. Submit your email\n2. If valid, a magic link is sent to your inbox\n3. Click the link to authenticate\n4. Use the `/auth/verify-magic-link` endpoint with the token", "type": "text/plain" }, "url": { "path": [ "auth", "request-magic-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "10c85264-64a5-4d21-8632-a73cf8bc7540", "name": "Magic link requested (uniform response)", "originalRequest": { "url": { "path": [ "auth", "request-magic-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"If this email is valid, a magic link has been sent. Check your inbox.\",\n \"expires_in_seconds\": 900\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8ef80fd-df20-4994-a2e1-c88c268c4c65", "name": "Validation Error", "originalRequest": { "url": { "path": [ "auth", "request-magic-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbd2f306-e86d-4356-801c-5b0f35e1b094", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "auth", "request-magic-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f40bb590-40da-415b-b25b-66b73d01ff4d", "name": "Service unavailable (email or database)", "originalRequest": { "url": { "path": [ "auth", "request-magic-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d5c455ed-ed78-4d91-8389-118d3a8c46fa", "name": "Verify magic link token and create session (V2)", "request": { "name": "Verify magic link token and create session (V2)", "description": { "content": "Verify a magic link token and create an authenticated session.\n\n## Auth V2 Response\n- **access_token**: JWT (15 min) - Store in memory, use in Authorization: Bearer\n- **refresh_token**: Set as HttpOnly cookie (30 days) - Browser handles automatically\n\n## Security\n- **Single-use**: Magic link token is invalidated after use\n- **Expiration**: Token must not be expired (15 min default)\n- **Access Token**: Short-lived, stored in memory (not localStorage!)\n- **Refresh Token**: HttpOnly cookie, SameSite=Lax, Secure\n\n## Flow\n1. Extract token from magic link URL\n2. Submit to this endpoint\n3. Store access_token in memory (React state/singleton)\n4. Use access_token for `/dashboard/*` endpoints\n5. When access_token expires, call `/auth/refresh`", "type": "text/plain" }, "url": { "path": [ "auth", "verify-magic-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "607bbcfd-6b17-44a8-a9c7-fe1395824f38", "name": "Login successful, access_token in body, refresh_token in cookie", "originalRequest": { "url": { "path": [ "auth", "verify-magic-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"user\": {},\n \"token_type\": \"Bearer\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e33014ba-68ec-4683-b7dd-9f9b79609367", "name": "Invalid or expired token", "originalRequest": { "url": { "path": [ "auth", "verify-magic-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a77c8721-87f0-4c48-b365-37eae5e290cb", "name": "User account is suspended or deleted", "originalRequest": { "url": { "path": [ "auth", "verify-magic-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2ba6f926-c947-4741-8385-5445d2d991bc", "name": "Validation Error", "originalRequest": { "url": { "path": [ "auth", "verify-magic-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49648e64-7037-488a-bcf7-89ab4a7c1a46", "name": "Service unavailable", "originalRequest": { "url": { "path": [ "auth", "verify-magic-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "77506e9e-5fe8-4fdc-b14d-3040597c8043", "name": "Refresh access token (V2)", "request": { "name": "Refresh access token (V2)", "description": { "content": "Exchange a valid refresh token for a new access token.\n\n## Token Rotation\n- The refresh token is **rotated** on each use (new token issued)\n- Old refresh token is invalidated\n- New refresh token set via HttpOnly cookie\n\n## Security\n- Detects token reuse (potential theft) and revokes session\n- Verifies user is still active (not suspended/deleted)\n\n## Usage\n```javascript\n// Automatic: browser sends refresh_token cookie\nconst response = await fetch('/auth/refresh', { method: 'POST', credentials: 'include' });\nconst { access_token, expires_in } = await response.json();\n// Store access_token in memory, use for next 15 minutes\n```", "type": "text/plain" }, "url": { "path": [ "auth", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "af7cb436-2ed8-466d-ae63-33e5465b8f67", "name": "New access token issued, refresh token rotated", "originalRequest": { "url": { "path": [ "auth", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"Bearer\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb003e30-8934-43c4-a1b9-de4e15a683e3", "name": "Invalid, expired, or revoked refresh token", "originalRequest": { "url": { "path": [ "auth", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0c0e8fad-9953-4b38-8a61-251f50bdace5", "name": "Validation Error", "originalRequest": { "url": { "path": [ "auth", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98b9af3a-931d-47d8-824f-f860ab49208f", "name": "Service unavailable", "originalRequest": { "url": { "path": [ "auth", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e59cdea6-d7b9-4462-ae83-8a15746e3d13", "name": "Log out current session", "request": { "name": "Log out current session", "description": { "content": "Log out the current session and clear cookies.\n\n## Behavior\n- Revokes the current session in DB (refresh token invalidated)\n- Clears refresh_token cookie\n- Clears V1 session cookie (backward compatibility)\n\n## Note\nThis endpoint works even without a valid session - it will clear cookies regardless.\nFor authenticated logout with user context, use with Authorization header.", "type": "text/plain" }, "url": { "path": [ "auth", "logout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "5419ff4b-6b5f-4be6-a119-b4244f33fc39", "name": "Logged out successfully", "originalRequest": { "url": { "path": [ "auth", "logout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Logged out successfully\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c607178-4e0a-4091-8c19-0a3047041400", "name": "Validation Error", "originalRequest": { "url": { "path": [ "auth", "logout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f57618ce-1d4b-46af-8cc5-73d97cc19a48", "name": "Log out all sessions", "request": { "name": "Log out all sessions", "description": { "content": "Revoke all active sessions for the current user.\n\n## Use Cases\n- Security event (password change, suspicious activity)\n- User wants to log out from all devices\n- Account deletion preparation\n\n## Requires\n- Valid access token in Authorization: Bearer header", "type": "text/plain" }, "url": { "path": [ "auth", "logout-all" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "3960c11b-8bc4-4184-986e-9a3c2ba465d8", "name": "All sessions revoked", "originalRequest": { "url": { "path": [ "auth", "logout-all" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"sessions_revoked\": \"\",\n \"message\": \"All sessions revoked\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac14403f-23d1-4d18-ad26-8bf6ef930b49", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "auth", "logout-all" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c1c2f788-559d-4bf2-a422-743d12857c2e", "name": "Validation Error", "originalRequest": { "url": { "path": [ "auth", "logout-all" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "dashboard", "description": "", "item": [ { "id": "cb5f5936-1ecb-4fe6-b6af-4ec4755d294d", "name": "Get current user profile", "request": { "name": "Get current user profile", "description": { "content": "Get the authenticated user's profile information including plan and verification status.", "type": "text/plain" }, "url": { "path": [ "dashboard", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b715356e-f999-44fd-aba1-7423330dede2", "name": "User profile", "originalRequest": { "url": { "path": [ "dashboard", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"user_id\": \"\",\n \"email\": \"\",\n \"status\": \"\",\n \"plan\": \"\",\n \"created_at\": \"\",\n \"activated_api\": \"\",\n \"verified_at\": \"\",\n \"stripe_customer_id\": \"\",\n \"subscription\": {\n \"subscription_status\": \"\",\n \"payment_status\": \"\",\n \"current_period_end\": \"\"\n },\n \"bonus_quota\": {\n \"active\": \"\",\n \"total_bonus\": \"\",\n \"active_count\": \"\",\n \"nearest_expiration\": \"\"\n },\n \"pilot_access\": {\n \"active\": \"\",\n \"kind\": \"integration_pilot\",\n \"label\": \"Accès intégration\",\n \"expires_at\": \"\",\n \"days_remaining\": \"\",\n \"note\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eacf64db-1b07-41e1-860d-684a36517855", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "dashboard", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "03c9e2f8-57f7-4f75-9435-6b56365cf2a7", "name": "User suspended", "originalRequest": { "url": { "path": [ "dashboard", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ff3af2a6-a62e-47b2-8c99-f1a033ba8139", "name": "Validation Error", "originalRequest": { "url": { "path": [ "dashboard", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b6928122-c792-4d06-8ace-cf9d6d2ad1e6", "name": "List user's API keys", "request": { "name": "List user's API keys", "description": { "content": "Get all API keys belonging to the authenticated user.", "type": "text/plain" }, "url": { "path": [ "dashboard", "keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "39a8fae3-77ed-487c-adda-2533ffb7e876", "name": "List of API keys", "originalRequest": { "url": { "path": [ "dashboard", "keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"keys\": [\n {\n \"id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"label\": \"\",\n \"plan\": \"\",\n \"last_used_at\": \"\",\n \"revoked_at\": \"\",\n \"key_masked\": \"\"\n },\n {\n \"id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"label\": \"\",\n \"plan\": \"\",\n \"last_used_at\": \"\",\n \"revoked_at\": \"\",\n \"key_masked\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07793d8f-d96e-498a-b7cf-60ea37c2d12a", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "dashboard", "keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b817b65c-74d3-4f9a-a0cf-8128e1634559", "name": "Validation Error", "originalRequest": { "url": { "path": [ "dashboard", "keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00e2ee43-0966-4547-b443-b94d46f8e311", "name": "Database unavailable", "originalRequest": { "url": { "path": [ "dashboard", "keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "75f8c063-23ea-48cb-9d65-24faddc7f61b", "name": "Create a new API key", "request": { "name": "Create a new API key", "description": { "content": "Create a new API key for the authenticated user.\n\n**Important**: The API key is returned only once. Save it immediately!\n\n## Limits\n- Free plan: Only 1 active key allowed\n- Paid plans: Multiple keys allowed", "type": "text/plain" }, "url": { "path": [ "dashboard", "keys", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"plan_code\": \"free\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b71a940c-4c68-4c27-bbcd-68833860654b", "name": "API key created", "originalRequest": { "url": { "path": [ "dashboard", "keys", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"plan_code\": \"free\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"api_key\": \"\",\n \"key\": {\n \"id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"label\": \"\",\n \"plan\": \"\",\n \"last_used_at\": \"\",\n \"revoked_at\": \"\",\n \"key_masked\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d15d29e-6928-448e-b383-04213ef04c01", "name": "Invalid request (e.g., free key limit reached)", "originalRequest": { "url": { "path": [ "dashboard", "keys", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"plan_code\": \"free\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8179171d-8698-4159-b8c1-f78edd322900", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "dashboard", "keys", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"plan_code\": \"free\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0553c1d5-0eab-463c-9be7-1b92567ef1e0", "name": "Validation Error", "originalRequest": { "url": { "path": [ "dashboard", "keys", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"plan_code\": \"free\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b484cc30-1250-49f1-96a2-7db5acace673", "name": "Database unavailable", "originalRequest": { "url": { "path": [ "dashboard", "keys", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"plan_code\": \"free\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bb60f2b1-68ea-4ee1-a8f1-79fcadf5c1e1", "name": "Revoke an API key", "request": { "name": "Revoke an API key", "description": { "content": "Revoke an API key belonging to the authenticated user.", "type": "text/plain" }, "url": { "path": [ "dashboard", "keys", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5e8132dc-3f6e-4763-9912-6c44da0de8e5", "name": "API key revoked", "originalRequest": { "url": { "path": [ "dashboard", "keys", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f81e09f7-0dd2-4846-a567-70818b55884a", "name": "Invalid request", "originalRequest": { "url": { "path": [ "dashboard", "keys", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "85ab2a06-8407-4d47-8b4d-ddfc9d1bbd73", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "dashboard", "keys", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "675d3d77-e143-4aa7-9156-74b0653fb72b", "name": "API key not found", "originalRequest": { "url": { "path": [ "dashboard", "keys", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5d9110bb-3739-4e1b-9a6b-dd8eb0925f38", "name": "Validation Error", "originalRequest": { "url": { "path": [ "dashboard", "keys", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c92d839-7449-4697-83d2-b90f6df510b2", "name": "Database unavailable", "originalRequest": { "url": { "path": [ "dashboard", "keys", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2833931d-b69d-4f21-9339-f7445ffba6de", "name": "Rename an API key", "request": { "name": "Rename an API key", "description": { "content": "Update the label of an API key belonging to the authenticated user.", "type": "text/plain" }, "url": { "path": [ "dashboard", "keys", "rename" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_id\": \"\",\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "de3d5f37-93b0-4329-8e87-7d9f5623010e", "name": "API key renamed", "originalRequest": { "url": { "path": [ "dashboard", "keys", "rename" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_id\": \"\",\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72270488-ca9c-40cc-b68d-27fda3cdf411", "name": "Invalid request", "originalRequest": { "url": { "path": [ "dashboard", "keys", "rename" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_id\": \"\",\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "afe290aa-a18a-4f02-b83e-402dca38c37e", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "dashboard", "keys", "rename" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_id\": \"\",\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "129352d5-ff5f-4376-b602-095e1aa1da48", "name": "API key not found", "originalRequest": { "url": { "path": [ "dashboard", "keys", "rename" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_id\": \"\",\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "25451592-d0ab-43b3-8507-1634f96909d5", "name": "Validation Error", "originalRequest": { "url": { "path": [ "dashboard", "keys", "rename" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_id\": \"\",\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b36842a-724e-4648-8631-830d78a64ec1", "name": "Database unavailable", "originalRequest": { "url": { "path": [ "dashboard", "keys", "rename" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_id\": \"\",\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e73df2a7-fac0-49b3-9628-38566ed52689", "name": "Get current usage statistics", "request": { "name": "Get current usage statistics", "description": { "content": "Get the authenticated user's current monthly usage statistics.", "type": "text/plain" }, "url": { "path": [ "dashboard", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9ed41471-e656-47f5-bcd6-afe79ba65ced", "name": "Current usage statistics", "originalRequest": { "url": { "path": [ "dashboard", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"plan\": \"\",\n \"quota\": \"\",\n \"count\": \"\",\n \"period_start\": \"\",\n \"period_end\": \"\",\n \"remaining\": \"\",\n \"usage_percent\": \"\",\n \"base_quota\": \"\",\n \"bonus_quota\": \"\",\n \"credits_remaining\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a1abeb4-c5da-4b61-863f-aaa9becdfaad", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "dashboard", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "59d63d1f-f15b-4a75-9895-fe780f24fda0", "name": "Validation Error", "originalRequest": { "url": { "path": [ "dashboard", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47bb1693-7da2-4d4e-8fd5-3981a451d795", "name": "Database unavailable", "originalRequest": { "url": { "path": [ "dashboard", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a9ea1192-a680-4526-845e-d15724d5a5a2", "name": "Submit Feedback", "request": { "name": "Submit Feedback", "description": { "content": "Submit contextual feedback from dashboard UI.\n\nLogs the feedback as a funnel event and records it in the\nfeedback_prompt_log for frequency cap analysis.\n\nDesigned for ultra-lightweight, non-intrusive feedback collection:\n- One question per moment\n- Never blocking\n- Optional free text", "type": "text/plain" }, "url": { "path": [ "dashboard", "feedback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"feedback_type\": \"\",\n \"sentiment\": \"\",\n \"selected_option\": \"\",\n \"rating\": \"\",\n \"free_text\": \"\",\n \"context\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "67403d4d-59cf-457c-9104-f5dcda7cbc8c", "name": "Successful Response", "originalRequest": { "url": { "path": [ "dashboard", "feedback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"feedback_type\": \"\",\n \"sentiment\": \"\",\n \"selected_option\": \"\",\n \"rating\": \"\",\n \"free_text\": \"\",\n \"context\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\",\n \"message\": \"Merci pour votre retour.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66fa82a2-ede6-4219-963a-ad484088fcee", "name": "Validation Error", "originalRequest": { "url": { "path": [ "dashboard", "feedback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"feedback_type\": \"\",\n \"sentiment\": \"\",\n \"selected_option\": \"\",\n \"rating\": \"\",\n \"free_text\": \"\",\n \"context\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "internal", "description": "", "item": [ { "id": "02d12d0b-c06b-439b-8d83-14a3aed48a5a", "name": "Debug current session (DEBUG mode only)", "request": { "name": "Debug current session (DEBUG mode only)", "description": { "content": "Decode and return the JWT claims from the current session cookie.\n\n**SECURITY**: This endpoint is only available when DEBUG=true.\nIn production, it returns 404.\n\nUseful for:\n- Debugging cookie issues during frontend development\n- Verifying JWT claims and expiration\n- Testing authentication flow", "type": "text/plain" }, "url": { "path": [ "internal", "debug", "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "59d3a307-7236-4772-9b39-47e65cb2de35", "name": "Session claims decoded", "originalRequest": { "url": { "path": [ "internal", "debug", "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c79e09b2-de39-4487-9b85-9835b6238436", "name": "No session or invalid session", "originalRequest": { "url": { "path": [ "internal", "debug", "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0a6d5256-b2f8-4c26-9de0-d0f4830e79ae", "name": "Endpoint not available (DEBUG=false)", "originalRequest": { "url": { "path": [ "internal", "debug", "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b16d3922-614e-491b-94da-6bc12e30fdec", "name": "Validation Error", "originalRequest": { "url": { "path": [ "internal", "debug", "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": \"\",\n \"ctx\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "67cb9eb7-9c97-4eac-9e4a-fb84d63a2331", "name": "Debug configuration (DEBUG mode only)", "request": { "name": "Debug configuration (DEBUG mode only)", "description": { "content": "Show non-sensitive configuration values for debugging.", "type": "text/plain" }, "url": { "path": [ "internal", "debug", "config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b098990c-c8c8-4507-b69c-da6c045e0e2d", "name": "Configuration overview", "originalRequest": { "url": { "path": [ "internal", "debug", "config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d638113-1a72-4cb0-841c-097c3c637a25", "name": "Endpoint not available (DEBUG=false)", "originalRequest": { "url": { "path": [ "internal", "debug", "config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "dfc9199f-c1a8-4db4-a269-ce79568aebac", "name": "Root", "request": { "name": "Root", "description": { "content": "Root endpoint - API information.", "type": "text/plain" }, "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cc2b6f80-b710-47e0-b067-2a191736a2c7", "name": "Successful Response", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": \"\",\n \"key_1\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "67c72b33-406b-4985-a21d-1230d642fe7c", "name": "Health", "request": { "name": "Health", "description": { "content": "Health check endpoint with database ping.\n\nReturns:\n - {\"status\": \"ok\", \"db\": \"ok\"} if all systems operational\n - {\"status\": \"degraded\", \"db\": \"error\"} with 503 if DB unavailable", "type": "text/plain" }, "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e3d50b83-d5ab-4362-8767-526750ddd506", "name": "Successful Response", "originalRequest": { "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [], "variable": [ { "key": "baseUrl", "value": "/" } ], "info": { "_postman_id": "f129c0d5-ab89-4d2a-8741-c887fdd86676", "name": "Factur-X Validation API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "\n# Factur-X Validation API\n\nAPI REST pour la validation de factures électroniques au format **Factur-X** (PDF avec XML embarqué)\nconforme à la norme européenne **EN16931**.\n\n## 🎯 Fonctionnalités\n\n- ✅ Validation XSD (structure XML)\n- ✅ Validation Schematron (règles métier EN16931)\n- ✅ Support PDF Factur-X (extraction automatique du XML)\n- ✅ Support XML standalone\n- ✅ Stockage temporaire sécurisé (R2/Local)\n- ✅ Rapports de validation détaillés (erreurs + warnings)\n\n## 📖 Utilisation\n\n### Validation d'un fichier\n\n```bash\ncurl -X POST \"http://localhost:8000/api/v1/validate\" \\\n -H \"Content-Type: multipart/form-data\" \\\n -H \"Authorization: Bearer \" \\\n -F \"file=@facture.xml\"\n```\n\n### Réponse\n\n```json\n{\n \"valid\": true,\n \"errors\": [],\n \"warnings\": [],\n \"message\": \"Validation completed\"\n}\n```\n\n## 🔗 Ressources\n\n- **Documentation interactive** : [/docs](/docs)\n- **Documentation alternative** : [/redoc](/redoc)\n- **Health check** : [/health](/health)\n \n\nContact Support:\n Name: Factur-X Validation API", "type": "text/plain" } } }