{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Documentation Overview","description":"Developer documentation for integrating systems that send messages, plus reporting and operational APIs for platform holders."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"documentation-overview","__idx":0},"children":["Documentation Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This section explains how the Digital Post Platform is structured, how digital messages are processed, and how different platform components interact."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["It is intended for developers and technical integrators who need to understand platform concepts, workflows, and operational models in order to design, implement, and maintain reliable integrations."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["While the Getting Started section focuses on completing a first integration, this section focuses on understanding how the platform works."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"purpose-of-this-section","__idx":1},"children":["Purpose of This Section"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Documentation section provides:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Conceptual explanations of platform architecture"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Descriptions of core domain models"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Message delivery and processing workflows"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Identity and recipient resolution concepts"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Security and encryption principles"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Error handling and retry behavior"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Reporting and audit mechanisms"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This information supports long term integration design, troubleshooting, and optimization."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"intended-audience","__idx":2},"children":["Intended Audience"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This documentation is intended for:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Developers integrating sender systems with the platform"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Technical architects designing integration solutions"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Platform holder developers building custom frontends"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Technical support and operations teams"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["It assumes familiarity with:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["REST based APIs"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Authentication and authorization mechanisms"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Object storage systems"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Message based integration patterns"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"scope","__idx":3},"children":["Scope"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This section covers platform behavior at a conceptual and technical level."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["It includes:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Organisational structure and governance model"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Sender identity management concepts"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Message submission and delivery models"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Recipient identification mechanisms"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Message lifecycle stages"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Optional security and encryption models"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Delivery guarantees and limitations"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["It does not include:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Administrative procedures"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Commercial terms"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Operational policies"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Market specific configurations"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["User interface instructions"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Where relevant, links to external administrative documentation are provided."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-to-use-this-section","__idx":4},"children":["How to Use This Section"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Readers are encouraged to review this section before implementing advanced integrations."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Typical usage patterns include:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Reviewing the organisational model before onboarding senders"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Understanding delivery behavior before batching messages"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Studying lifecycle stages before implementing status polling"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Reviewing security concepts before enabling client side encryption"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each page can be read independently, but together they describe the complete operational model of the platform."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"structure-of-this-section","__idx":5},"children":["Structure of This Section"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Documentation section is organized into the following main topics:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/documentation/platform-overview"},"children":["Platform Overview"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Introduces the main platform components and their relationships."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/documentation/organisational-model"},"children":["Organisational Model"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Explains how platform holders, organisation accounts, sender identities, and receivers are structured."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/documentation/delivery-model"},"children":["Message Delivery Model"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Describes how deliveries and envelopes are submitted and processed."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/documentation/message-lifecycle"},"children":["Message Lifecycle"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Explains how messages progress from submission to delivery and archival."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/documentation/recipient-identification"},"children":["Recipient Identification"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Describes how receivers are identified and resolved."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/documentation/security"},"children":["Security Concepts"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Explains authentication, encryption, and access control at a conceptual level."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/documentation/status-reporting"},"children":["Reporting and Status"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Describes delivery reporting, audit logs, and usage reporting."]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"relationship-to-other-sections","__idx":6},"children":["Relationship to Other Sections"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This section complements other parts of the documentation:"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"getting-started","__idx":7},"children":["Getting Started"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/overview"},"children":["Getting Started"]}," provides step by step guidance for first time integrations."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"api-reference","__idx":8},"children":["API Reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api"},"children":["API Reference"]}," provides detailed endpoint specifications, parameters, and schemas."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Developers are encouraged to use all sections together for a complete understanding."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"terminology-and-consistency","__idx":9},"children":["Terminology and Consistency"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All terms in this section follow the definitions in the platform ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/documentation/glossary"},"children":["glossary"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Key terms such as:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Platform holder"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Organisation account"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Sender identity"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Receiver"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["are used consistently throughout the documentation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["No alternative terminology is introduced."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"change-management","__idx":10},"children":["Change Management"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This documentation is maintained alongside platform releases."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When platform behavior changes:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Conceptual descriptions are updated"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Related sections are revised"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Deprecated behaviors are documented"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Integrators should review this section regularly to remain aligned with platform updates."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":11},"children":["Next Steps"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To begin exploring platform concepts, start with:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/documentation/platform-overview"},"children":["Platform Overview"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/documentation/organisational-model"},"children":["Organisational Model"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/documentation/delivery-model"},"children":["Message Delivery Model"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These pages provide the foundation for all other documentation."]}]},"headings":[{"value":"Documentation Overview","id":"documentation-overview","depth":1},{"value":"Purpose of This Section","id":"purpose-of-this-section","depth":2},{"value":"Intended Audience","id":"intended-audience","depth":2},{"value":"Scope","id":"scope","depth":2},{"value":"How to Use This Section","id":"how-to-use-this-section","depth":2},{"value":"Structure of This Section","id":"structure-of-this-section","depth":2},{"value":"Relationship to Other Sections","id":"relationship-to-other-sections","depth":2},{"value":"Getting Started","id":"getting-started","depth":3},{"value":"API Reference","id":"api-reference","depth":3},{"value":"Terminology and Consistency","id":"terminology-and-consistency","depth":2},{"value":"Change Management","id":"change-management","depth":2},{"value":"Next Steps","id":"next-steps","depth":2}],"frontmatter":{"title":"Documentation Overview","description":"Conceptual and technical documentation for understanding how the Digital Post Platform works.","seo":{"title":"Documentation Overview"}},"lastModified":"2026-02-20T11:36:31.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/documentation/overview","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}