Skip to content
Swiss federal authorities

Payload Specification🔗

Introduction🔗

The payload represents the business data being exchanged between sedex participants. It is the core of the message and can contain any type of data relevant to the business process. sedex imposes no restrictions on the content or format of the payload, allowing participants to transmit data tailored to their specific needs.

Allowed Formats🔗

All file formats are supported by sedex for the payload. Participants can exchange data in formats such as:

  • XML
  • JSON
  • PDF
  • CSV
  • ZIP
  • Binary files (e.g., images, videos)

The payload format and structure must be agreed upon between the sending and receiving applications. sedex itself does not validate or enforce payload-specific rules.

Size Limitations🔗

The maximum size of a single payload is 10 GB.

Security🔗

The payload is encrypted by the sedex-Client using the recipient's public key, ensuring that only the intended recipient can decrypt and read the data.

Naming Conventions🔗

When providing the payload as a file, the following rules apply:

  • The payload file must have a file extension (e.g., .xml, .json, .pdf, .dat, ...).
  • The payload file must have a prefix data_
  • There are no restrictions on the type of file extension used.
  • The file name can be generated using:
    • A unique messageId from the envelope.
    • A universally unique identifier (UUID).
    • Any other naming scheme generating unique name.
  • The generated part of the filename must be the same as in the envelope

Examples:

  • data_12345.xml
  • data_8734ad77-b123-4a56-8f0e-1234abcd5678.json
  • data_0000000001.zip

Base Filename Not Applied on Receiving End

When receiving a sedex message, the system retains the original file extension of the payload. However, the message itself is assigned a new base filename. This ensures that each received file has a unique name. Consequently, the sender cannot rely on their chosen filename being preserved upon reception.

Multiple Files🔗

If multiple files are part of a single payload, they should be packaged in a container format such as ZIP.

Responsibilities🔗

Sender Responsibilities:

  • Ensure the payload conforms to the agreed format and structure.
  • Validate the payload content as needed for business logic before transmission.

Recipient Responsibilities:

  • Validate the payload content and structure as required by the business process.
  • Ensure the ability to process the expected payload formats.

Error Handling🔗

If an envelope is found without an associated payload, the sedex-Client will issue a receipt with the status code 202 ("No Payload Found").

If the payload exceeds the maximum size, the sedex-Client will reject the message and issue a receipt with an appropriate error code.