# PagoPA Purpose Templates API **Canonical:** https://apis.io/apis/pagopa/pagopa-purposetemplates-api/ **Provider:** PagoPA — https://apis.io/providers/pagopa/ **Base URL:** https://api.platform.pagopa.it/bizevents/service/v1 **Documentation:** https://developer.pagopa.it/it/pago-pa/api/recupero-receipt PagoPA Purpose Templates API is one of 83 APIs that [PagoPA](https://apis.io/providers/pagopa/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 96 JSON Schema definitions. Tagged areas include purposeTemplates. The published artifact set on APIs.io includes an OpenAPI specification and 96 JSON Schemas. Purpose Templates routes ## Operations (18) | Method | Path | Summary | |---|---|---| | GET | `/purposeTemplates` | List Purpose Templates | | POST | `/purposeTemplates` | Create a new Purpose Template | | GET | `/purposeTemplates/{purposeTemplateId}` | Retrieve a Purpose Template | | PATCH | `/purposeTemplates/{purposeTemplateId}` | Update a Draft Purpose Template | | DELETE | `/purposeTemplates/{purposeTemplateId}` | Delete a Purpose Template in Draft state | | GET | `/purposeTemplates/{purposeTemplateId}/riskAnalysis` | Retrieve the Risk Analysis of a Purpose Template | | PUT | `/purposeTemplates/{purposeTemplateId}/riskAnalysis` | Replace the Risk Analysis of a Purpose Template | | GET | `/purposeTemplates/{purposeTemplateId}/riskAnalysis/annotationDocuments` | Retrieve a list of Risk Analysis Template Annotation Documents | | POST | `/purposeTemplates/{purposeTemplateId}/riskAnalysis/annotationDocuments` | Upload a Risk Analysis Form Template Answer Annotation Document | | GET | `/purposeTemplates/{purposeTemplateId}/riskAnalysis/annotationDocuments/{documentId}` | Retrieve the Document of a Risk Analysis Form Template Answer Annotation | | DELETE | `/purposeTemplates/{purposeTemplateId}/riskAnalysis/annotationDocuments/{documentId}` | Delete the Document of a Risk Analysis Form Template Answer Annotation | | GET | `/purposeTemplates/{purposeTemplateId}/eservices` | List E-Services linked to a Purpose Template | | POST | `/purposeTemplates/{purposeTemplateId}/eservices` | Link an E-Service to a Purpose Template | | DELETE | `/purposeTemplates/{purposeTemplateId}/eservices/{eserviceId}` | Unlink an E-Service From Purpose Template | | POST | `/purposeTemplates/{purposeTemplateId}/publish` | Publish a Purpose Template in Draft state | | POST | `/purposeTemplates/{purposeTemplateId}/archive` | Archive a Purpose Template in Published or Suspended state | | POST | `/purposeTemplates/{purposeTemplateId}/unsuspend` | Unsuspend a Purpose Template in Suspended state | | POST | `/purposeTemplates/{purposeTemplateId}/suspend` | Suspend a Purpose Template in Published state | ## Machine-readable artifacts (97) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/openapi/pagopa-purposetemplates-api-openapi.yml - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-ct-receipt-model-response-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-cart-request-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-get-cart-response-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-get-mbd-request-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-get-mdb-receipt-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-create-mbd-request-v2-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-single-flow-response-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-paginated-payments-response-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-paginated-flows-response-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-create-flow-request-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-single-flow-created-response-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-paginated-flows-published-response-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-paginated-flows-created-response-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-payment-position-model-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-payments-model-response-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-payment-position-model-base-response-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-payment-positions-info-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-app-info-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-already-paid-payment-option-model-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-file-id-list-response-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-upload-report-dto-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-upload-status-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-update-transfer-iban-massive-response-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-payment-position-model-v3-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-payment-position-model-response-v3-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-payment-positions-info-v3-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-flow-list-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-upload-report-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-receipts-info-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-broker-institutions-response-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-ciibans-response-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-payment-options-response-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-new-debt-position-request-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-debt-position-response-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-get-generation-request-status-resource-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-template-resource-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-notice-generation-request-item-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-notice-generation-massive-request-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pagopa/refs/heads/main/json-schema/pagopa-notice-generation-massive-resource-schema.json - …and 57 more, listed in full on the page. ## Other PagoPA APIs (12) - [pagoPA - Nodo dei Pagamenti SOAP interfaces](https://apis.io/apis/pagopa/pagopa-nodo-dei-pagamenti-soap-interfaces/) - [PagoPA ACA API](https://apis.io/apis/pagopa/pagopa-aca-api/) - [PagoPA Activations API](https://apis.io/apis/pagopa/pagopa-activations-api/) - [PagoPA Agreements API](https://apis.io/apis/pagopa/pagopa-agreements-api/) - [PagoPA Attributes API](https://apis.io/apis/pagopa/pagopa-attributes-api/) - [PagoPA b2b - pagoPA side API](https://apis.io/apis/pagopa/pagopa-b2b-pagopa-side-api/) - [PagoPA Callback API](https://apis.io/apis/pagopa/pagopa-callback-api/) - [PagoPA Callback Cancel API](https://apis.io/apis/pagopa/pagopa-callback-cancel-api/) - [PagoPA Carts API](https://apis.io/apis/pagopa/pagopa-carts-api/) - [PagoPA Check API](https://apis.io/apis/pagopa/pagopa-check-api/) - [PagoPA Citizen operation API](https://apis.io/apis/pagopa/pagopa-citizen-operation-api/) - [PagoPA Clients API](https://apis.io/apis/pagopa/pagopa-clients-api/) ## Tags purposeTemplates --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/pagopa/pagopa-purposetemplates-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/pagopa/.