{"items":[{"type":"group","label":"Integration Fundamentals","items":[{"type":"link","fsPath":"introduction/overview.md","metadata":{"type":"markdown"},"label":"Overview","link":"/introduction/overview","routeSlug":"/introduction/overview"},{"type":"link","fsPath":"introduction/organisational-model.md","metadata":{"type":"markdown"},"label":"Organisational Model","link":"/introduction/organisational-model","routeSlug":"/introduction/organisational-model"},{"type":"link","fsPath":"introduction/delivery-model.md","metadata":{"type":"markdown"},"label":"Message Delivery Model","link":"/introduction/delivery-model","routeSlug":"/introduction/delivery-model"},{"type":"link","fsPath":"introduction/message-lifecycle.md","metadata":{"type":"markdown"},"label":"Message Lifecycle","link":"/introduction/message-lifecycle","routeSlug":"/introduction/message-lifecycle"},{"type":"link","fsPath":"introduction/security-concepts.md","metadata":{"type":"markdown"},"label":"Security Concepts","link":"/introduction/security-concepts","routeSlug":"/introduction/security-concepts"}]},{"type":"group","label":"Getting Started","items":[{"type":"link","fsPath":"getting-started/overview.md","metadata":{"type":"markdown"},"label":"Getting Started Overview","link":"/getting-started/overview","routeSlug":"/getting-started/overview"},{"type":"link","fsPath":"getting-started/prerequisites.md","metadata":{"type":"markdown"},"label":"Prerequisites and Access","link":"/getting-started/prerequisites","routeSlug":"/getting-started/prerequisites"},{"type":"link","fsPath":"getting-started/authentication.md","metadata":{"type":"markdown"},"label":"Authentication Setup","link":"/getting-started/authentication","routeSlug":"/getting-started/authentication"},{"type":"link","fsPath":"getting-started/prepare-message.md","metadata":{"type":"markdown"},"label":"Prepare Your First Message","link":"/getting-started/prepare-message","routeSlug":"/getting-started/prepare-message"},{"type":"link","fsPath":"getting-started/ChooseSubmissionMethod.md","metadata":{"type":"markdown"},"label":"Choose a Submission Method","link":"/getting-started/choosesubmissionmethod","routeSlug":"/getting-started/choosesubmissionmethod"},{"type":"link","fsPath":"getting-started/upload-s3.md","metadata":{"type":"markdown"},"label":"Send Messages via S3 Delivery","link":"/getting-started/upload-s3","routeSlug":"/getting-started/upload-s3"},{"type":"link","fsPath":"getting-started/submit-multipart.md","metadata":{"type":"markdown"},"label":"Send messages via multipart upload","link":"/getting-started/submit-multipart","routeSlug":"/getting-started/submit-multipart"},{"type":"link","fsPath":"getting-started/verify-delivery.md","metadata":{"type":"markdown"},"label":"Verify and Troubleshoot","link":"/getting-started/verify-delivery","routeSlug":"/getting-started/verify-delivery"},{"type":"link","fsPath":"getting-started/encryption.md","metadata":{"type":"markdown"},"label":"Encrypting Content (Optional)","link":"/getting-started/encryption","routeSlug":"/getting-started/encryption"}]},{"type":"group","label":"Documentation","items":[{"type":"link","fsPath":"documentation/overview.md","metadata":{"type":"markdown"},"label":"Documentation Overview","link":"/documentation/overview","routeSlug":"/documentation/overview"},{"type":"link","fsPath":"documentation/platform-overview.md","metadata":{"type":"markdown"},"label":"Platform Overview","link":"/documentation/platform-overview","routeSlug":"/documentation/platform-overview"},{"type":"link","fsPath":"documentation/organisational-model.md","metadata":{"type":"markdown"},"label":"Organisational Model","link":"/documentation/organisational-model","routeSlug":"/documentation/organisational-model"},{"type":"link","fsPath":"documentation/recipient-identification.md","metadata":{"type":"markdown"},"label":"Recipient Identification","link":"/documentation/recipient-identification","routeSlug":"/documentation/recipient-identification"},{"type":"link","fsPath":"documentation/delivery-model.md","metadata":{"type":"markdown"},"label":"Message Delivery Model","link":"/documentation/delivery-model","routeSlug":"/documentation/delivery-model"},{"type":"link","fsPath":"documentation/message-lifecycle.md","metadata":{"type":"markdown"},"label":"Message Lifecycle","link":"/documentation/message-lifecycle","routeSlug":"/documentation/message-lifecycle"},{"type":"link","fsPath":"documentation/status-reporting.md","metadata":{"type":"markdown"},"label":"Status Reporting","link":"/documentation/status-reporting","routeSlug":"/documentation/status-reporting"},{"type":"link","fsPath":"documentation/billing-usage.md","metadata":{"type":"markdown"},"label":"Billing Usage","link":"/documentation/billing-usage","routeSlug":"/documentation/billing-usage"},{"type":"link","fsPath":"documentation/security.md","metadata":{"type":"markdown"},"label":"Security Concepts","link":"/documentation/security","routeSlug":"/documentation/security"},{"type":"link","fsPath":"documentation/glossary.md","metadata":{"type":"markdown"},"label":"Glossary","link":"/documentation/glossary","routeSlug":"/documentation/glossary"},{"type":"link","fsPath":"documentation/delivery.md","metadata":{"type":"markdown"},"label":"Delivery","link":"/documentation/delivery","routeSlug":"/documentation/delivery"},{"type":"link","fsPath":"tutorials/cbc-encryption-and-encoding.md","metadata":{"type":"markdown"},"label":"Encrypting data using AES-256 CBC and encoding for DPP","link":"/tutorials/cbc-encryption-and-encoding","routeSlug":"/tutorials/cbc-encryption-and-encoding"}]},{"type":"group","fsPath":"api/index.md","metadata":{"type":"markdown","pageType":"custom","hideLastUpdated":true},"label":"API Reference","link":"/api","routeSlug":"/api","items":[{"type":"link","fsPath":"api/authentication.md","metadata":{"type":"markdown"},"label":"Authentication","link":"/api/authentication","routeSlug":"/api/authentication"},{"type":"link","fsPath":"api/versioning.md","metadata":{"type":"markdown"},"label":"Versioning and deprecation","link":"/api/versioning","routeSlug":"/api/versioning"},{"type":"link","fsPath":"api/errors.md","metadata":{"type":"markdown"},"label":"Error Handling","link":"/api/errors","routeSlug":"/api/errors"},{"type":"group","label":"Schemas","items":[{"type":"link","fsPath":"apis/schemas/envelope-schema.md","metadata":{"type":"markdown"},"label":"Envelope Schema","link":"/apis/schemas/envelope-schema","routeSlug":"/apis/schemas/envelope-schema"}]},{"type":"group","fsPath":"apis/billing/@1.0/billing.yaml","link":"/apis/billing/billing","routeSlug":"/apis/billing/billing","label":"Billing API","items":[{"label":"Get aggregated usage report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing/billing/other/getmessagesentusage","routeSlug":"/apis/billing/billing/other/getmessagesentusage","metadata":{"seo":{"title":"Get aggregated usage report","description":"Retrieves an aggregated usage report for the specified organization and date range."}},"httpPath":"/platformdata/v1/usage","version":"1.0","isDefault":true,"versionFolderId":"cac1f638"}],"metadata":{"type":"openapi","title":"Billing API","version":"1.0","description":"Provides aggregated message-sending usage data for billing purposes.\n\nUse this API to retrieve a hierarchical breakdown of messages sent by an\norganization and its sub-organizations over a specified date range.\n\nThe usage report includes aggregated sent message totals for the requested organization, its direct senders, and all descendant sub-organizations.\n\nAccess to usage data is restricted to callers with the `Billing.ReadDataFiles` claim.\nIn addition, the caller must have billing access to the requested organization.\n\nValidation is applied to all query parameters. Dates must use ISO 8601 date format\n(`yyyy-MM-dd`), the time zone must be a valid IANA time zone identifier, `orgId`\nmust be a positive integer, and the requested period must not be in the future or\nolder than 5 years.\n\nSee [Billing Usage](../../../documentation/billing-usage.md) documentation for detailed billing behavior and aggregation rules.\n"},"version":"1.0","isDefault":true,"versionFolderId":"cac1f638"},{"type":"group","fsPath":"apis/delivery/@1.0/delivery.yaml","link":"/apis/delivery/delivery","routeSlug":"/apis/delivery/delivery","label":"Delivery API","items":[{"label":"Create delivery via multipart/form-data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/delivery/delivery/other/createmessagebundle","routeSlug":"/apis/delivery/delivery/other/createmessagebundle","metadata":{"seo":{"title":"Create delivery via multipart/form-data","description":"Uploads files as multipart form data to a platform-managed S3 bucket and initiates deliveryof the contained envelopes."}},"httpPath":"/delivery/v1/messages/{externalTransactionId}","version":"1.0","isDefault":true,"versionFolderId":"9d20e273"},{"label":"Create delivery via S3","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/delivery/delivery/other/createdelivery","routeSlug":"/apis/delivery/delivery/other/createdelivery","metadata":{"seo":{"title":"Create delivery via S3","description":"Creates a delivery and initiates delivery of the contained envelopes."}},"httpPath":"/delivery/v1/deliveries","version":"1.0","isDefault":true,"versionFolderId":"9d20e273"},{"label":"List deliveries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/delivery/delivery/other/listdeliveries","routeSlug":"/apis/delivery/delivery/other/listdeliveries","metadata":{"seo":{"title":"List deliveries","description":"Retrieves a paginated list of deliveries for the authenticated user's accessible organizations. Optionally filter by a specific sender organization. Pagination metadata is returned in the response headers."}},"httpPath":"/delivery/v1/deliveries","version":"1.0","isDefault":true,"versionFolderId":"9d20e273"},{"label":"Get delivery report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/delivery/delivery/other/getdeliveryreport","routeSlug":"/apis/delivery/delivery/other/getdeliveryreport","metadata":{"seo":{"title":"Get delivery report","description":"Retrieves the delivery report for a specific delivery, including its current status,envelope counts, and a log of any issues encountered during processing."}},"httpPath":"/delivery/v1/deliveries/{deliveryId}","version":"1.0","isDefault":true,"versionFolderId":"9d20e273"},{"label":"Get delivery confirmations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/delivery/delivery/other/getdeliveryconfirmations","routeSlug":"/apis/delivery/delivery/other/getdeliveryconfirmations","metadata":{"seo":{"title":"Get delivery confirmations","description":"Retrieves a paginated list of delivery confirmations for the envelopes in a delivery."}},"httpPath":"/delivery/v1/deliveries/{deliveryId}/confirmations","version":"1.0","isDefault":true,"versionFolderId":"9d20e273"}],"metadata":{"type":"openapi","title":"Delivery API","version":"1.0","description":"Enables the submission of message deliveries through either S3-based integration or multipart/form-data upload.\nA delivery consists of one or more envelopes that define the recipients,\nmessage content, and how recipients can interact with the message.\n\nDeliveries can be created in two ways:\n- **S3-based:** The sender uploads envelopes and content to their own S3 bucket and provides the\n  connection details in the request. The platform retrieves the content directly from the bucket.\n- **Multipart/form-data:** The sender uploads envelopes and content as multipart form data over\n  HTTPS. The platform stores the content in a platform-managed S3 bucket.\n\nRegardless of the submission method, the platform validates the envelopes, scans content for\nviruses, and encrypts each file with a unique key. The platform guarantees that either all\nrecipients of an envelope receive the message or none do.\n\nOptionally, S3 content may be encrypted by the sender using AES-256 with a client-managed key. A\ndelivery report is available to track processing progress and identify issues related to specific\nenvelopes.\n\nSee [Delivery](../../../documentation/delivery.md)\n"},"version":"1.0","isDefault":true,"versionFolderId":"9d20e273"}]}]}