The Italian version constitutes the only official and legally binding version of the document. The English-language version of this document is provided solely as a courtesy to facilitate consultation by users. In the event of any discrepancies, interpretive differences, or inconsistencies between the Italian-language version and any translated version, the Italian text alone shall prevail and be deemed authoritative.

Add attachments

This function is reserved to institutions who have signed up for the [Premium program](../../enabling/premium-function.md).

What are attachments

They are PDF documents shown at the bottom of the message content. These attachments are retrieved by the systems of the sending institution each time the user accesses the resource in the IO app.

To guarantee the accessibility and security of the documents, you _must_ use attachments in **PDF/A-2a format:** make sure to observe this rule.

How does it work?

Step 1- Define a remote configuration

To permit IO to know your systems dedicated to attachments, you must define at least one Remote Configuration, which you will indicate later when sending each message.

Step 2- Show the retrieval endpoints for the attachments

To permit IO to retrieve the content of a message and its attachments, **you must make a **REST web service available in compliance with the relative OpenAPI.

For more information, read OpenAPI recovery endpoint of remote content.

To include the attachments in a message, in addition to the steps indicated in ✉️ Send a message, you must follow these steps:

Step 3- Include the block Third_party_data

Include the Third_party_data block, specifying the reference Remote configuration and the remote correlation id, which IO returns to you when it asks you for the metadata and, subsequently, the bytes of the attachments to the particular message you are sending.

Step 4- Specify the value TRUE in the field Has_attachments

Specify the value true in the field Has_attachments present in the block Third_party_data.

Step 5- Specify the value ADVANCED in the field Feature_level_type

Specify the value ADVANCED in the field Feature_level_type present in the request.

Examples

Example of a call for sending a message with attachments:

1curl --location --request POST 'https://api.io.pagopa.it/api/v1/messages' \
2--header 'Ocp-Apim-Subscription-Key: <YOUR_API_KEY>' \
3--header 'Content-Type: application/json' \
4--data-raw '{
5  "content": {
6    "subject": "Message with attachments",
7    "markdown": "# Title\n\nMessage text: contains **attachments**!",
8    "third_party_data": {
9      "id": "c7832d5f-5946-48a3-ba9d-2d1e3aa3f7e5", 
10      "configuration_id": "0e9852ccb8a04128bd637c807b9d80d3",
11      "has_attachments": true
12    }
13  },
14  "feature_level_type": "ADVANCED",
15  "fiscal_code": "<validFiscalCode>",
16}'
17

Example of a positive response:

1{
2  "id": "01BX9NSMKVXXS5PSP2FATZMYYY"
3}
4

Please note that you are not actually sending the attachments when creating the message: you will do it later when the recipient wants to view them in the app and IO will invoke [the API ](../../api-and-specifications/openapi-recovery-endpoint-of-remote-content.md#endpoint-di-recupero-dei-byte-del-singolo-allegato) for the purpose

On this page

What are attachments

How does it work?

Examples