# Digipost API

>  Digipost is a norwegian digital mailbox service, operated by Posten Bring AS. The Digipost API lets organisations ("senders") send digital mail to citizens and businesses, look up and identify recipients, read documents from an organisation inbox, and request and read shared documents (Digipost Kontroll). It is a REST API that exchanges signed XML messages over TLS.
## Getting started

- [Get started](https://digipost.github.io/digipost-technical-docs/index.md): Register as a sender and send your first message, with minimal Java and .NET examples.
- [API overview](https://digipost.github.io/digipost-technical-docs/api/index.md): When to use a client library versus integrating directly.
- [Changes in API](https://digipost.github.io/digipost-technical-docs/api/changes.md): What changed in the latest version.

## Authentication and security

- [Security in the Digipost API](https://digipost.github.io/digipost-technical-docs/api/security.md): How requests are signed and responses verified, with a troubleshooting example.
- [HTTP headers](https://digipost.github.io/digipost-technical-docs/api-spec/header.md): Reference table of the required headers, with formats and examples.
- [Uploading your business certificate](https://digipost.github.io/digipost-technical-docs/api/certificate.md): Obtaining and uploading a Buypass or Digipost-issued certificate.

## Schemas and data types

- [Schema definitions](https://digipost.github.io/digipost-technical-docs/api/schema.md): The XSD and the application/vnd.digipost-v[number]+xml media type.
- [Data types](https://digipost.github.io/digipost-technical-docs/data-types/index.md): Optional machine-readable metadata sent with a document, such as Invoice or ShareDocumentsRequest.
- [Digipost address format](https://digipost.github.io/digipost-technical-docs/other/digipost-address.md): Addressing recipients by fødselsnummer, Digipost address, or name + street address. (Norwegian)

## Sending messages

- [Send](https://digipost.github.io/digipost-technical-docs/api-spec/send.md): Send a message with a single primary document.
- [Attachments](https://digipost.github.io/digipost-technical-docs/api-spec/attachment.md): Include one or more attachments alongside the primary document.
- [PDF format](https://digipost.github.io/digipost-technical-docs/other/pdf-format.md): PDF/A and accessibility requirements; pricing is by file size. (Norwegian)
- [Sending HTML documents](https://digipost.github.io/digipost-technical-docs/functionality/send-html.md): The allowed HTML subset and validating documents before sending. (Norwegian)

## Recipient lookup

- [Identify recipient](https://digipost.github.io/digipost-technical-docs/api-spec/identify.md): Check whether one specific person is a Digipost user; for fully automatic workflows.
- [Search](https://digipost.github.io/digipost-technical-docs/api-spec/search.md): Free-text recipient search returning up to 10 matches; a human must confirm before sending.

## Inbox

- [Get inbox](https://digipost.github.io/digipost-technical-docs/api-spec/inbox.md): List organisation-inbox document metadata; track documents by id, as ordering is not stable.
- [Get document](https://digipost.github.io/digipost-technical-docs/api-spec/get-document.md): Fetch a document's content through a short-lived, single-use download URL.
- [Delete document](https://digipost.github.io/digipost-technical-docs/api-spec/delete-document.md): Remove a document from the organisation inbox.

## Digipost Control

- [Send ShareDocumentsRequest](https://digipost.github.io/digipost-technical-docs/api-spec/control/send.md): Request shared documents with a stated purpose and maximum share duration.
- [Discover new shared documents](https://digipost.github.io/digipost-technical-docs/api-spec/control/get-shared.md): Poll for share events within a time range.
- [Get state of ShareDocumentsRequest](https://digipost.github.io/digipost-technical-docs/api-spec/control/get-state.md): Read shared documents and their expiry, with links to fetch content or stop sharing.

## Response codes

- [Response codes](https://digipost.github.io/digipost-technical-docs/api-spec/response-codes.md): HTTP status codes and the error element returned on failure.

## Integration and testing

- [Integration process](https://digipost.github.io/digipost-technical-docs/process/index.md): Steps to move a direct integration to production. (Norwegian)
- [Test environment](https://digipost.github.io/digipost-technical-docs/process/test-environment.md): The full send/receive test environment and how to create test users. (Norwegian)
- [Onboarding senders via brokers](https://digipost.github.io/digipost-technical-docs/process/onboarding.md): How broker partners add customers to an existing integration. (Norwegian)
- [Automatic onboarding](https://digipost.github.io/digipost-technical-docs/functionality/onboarding.md): Fully and semi-automated onboarding flows for broker partners. (Norwegian)

## Physical mail

- [Physical mail](https://digipost.github.io/digipost-technical-docs/physical-mail/index.md): Print-and-post fallback for recipients without a Digipost account. (Norwegian)
- [C4 & C5 envelopes](https://digipost.github.io/digipost-technical-docs/physical-mail/c4-c5.md): Envelope format specifications for physical mail.

## Health sector

- [API for the health sector](https://digipost.github.io/digipost-technical-docs/api-health/index.md): Digipost services available over Norsk Helsenett (NHN). (Norwegian)
- [Digipost API from NHN](https://digipost.github.io/digipost-technical-docs/api-health/nhn-api.md): Reaching the REST API over the NHN network. (Norwegian)
- [Digipost NHN mailbox](https://digipost.github.io/digipost-technical-docs/api-health/nhn-mailbox.md): Sending health documents (epikrise) to Digipost's NHN mailbox. (Norwegian)

## Operations

- [Operations and status](https://digipost.github.io/digipost-technical-docs/operations/index.md): Live service status and incident notices. (Norwegian)
- [Missending](https://digipost.github.io/digipost-technical-docs/operations/missending.md): Procedure for reporting misdirected mail. (Norwegian)
- [Firewall and IP addresses](https://digipost.github.io/digipost-technical-docs/operations/firewall-ip.md): IP ranges to allowlist for outbound connections.

## Digital wallet

- [Lommebok overview](https://digipost.github.io/digipost-technical-docs/lommebok/index.md): Wallet services and types for issuing and verifying credentials; test environment only. (Norwegian)
- [Issuer service (Utstedertjenesten)](https://digipost.github.io/digipost-technical-docs/lommebok/kom-i-gang-utsteder.md): Issue Verifiable Credentials via a Digipost message or credential-offer URI. (Norwegian)
- [Verifier service (Verifiseringstjenesten)](https://digipost.github.io/digipost-technical-docs/lommebok/kom-i-gang-verifiserer.md): Request and verify credentials held in a holder's wallet. (Norwegian)
- [Trust and certificates](https://digipost.github.io/digipost-technical-docs/lommebok/tillit-og-sertifikater.md): Certificate trust chain for the issuer and verifier services. (Norwegian)
- [Test resources (Testressurser)](https://digipost.github.io/digipost-technical-docs/lommebok/testressurser.md): Test accounts and resources for wallet integration. (Norwegian)

## Batch interface

- [Batch interface](https://digipost.github.io/digipost-technical-docs/batch/index.md): Legacy XML-over-SFTP interface, closed to new integrations — use the REST API instead.

## Reference and support

- [FAQ for developers](https://digipost.github.io/digipost-technical-docs/other/faq.md): Common questions on attachments, invoices, receipts, UUIDs, and test accounts. (Norwegian)
- [Contact information](https://digipost.github.io/digipost-technical-docs/other/contact.md): API support is api@digipost.no.
- [Open source](https://digipost.github.io/digipost-technical-docs/other/open-source.md): Java and .NET client-library repositories and documentation.
- [Blacklisting](https://digipost.github.io/digipost-technical-docs/other/blacklisting.md): How recipient blacklisting works and what it means for senders.
- [Accessibility](https://digipost.github.io/digipost-technical-docs/other/accessibility.md): Accessibility statement for the Digipost platform.