openapi: 3.2.0
info:
  title: Pagopa Legal Facts API
  version: 1.0.0
  contact:
    name: 'SEND: supporto enti'
    url: https://pagopa.atlassian.net/servicedesk/customer/portal/5
  termsOfService: https://selfcare.notifichedigitali.it/termini-di-servizio
  x-api-id: api-external-b2b-pa
  x-summary: 'Piattaforma Notifiche: API B2B per le Pubbliche Amministrazioni'
  description: 'Operations tagged LegalFacts across 2 of this provider''s published API definitions: send-b2b-pa-bundle.yaml, pagopa-send-b2b-pa-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.notifichedigitali.it
  description: Ambiente di produzione
- url: https://api.uat.notifichedigitali.it
  description: Ambiente di collaudo
security:
- ApiKeyAuth: []
tags:
- name: LegalFacts
  description: Invocazioni per effettuare il download degli atti opponibili a terzi
paths:
  /delivery-push/v2.0/{iun}/legal-facts:
    get:
      summary: Elenco atti opponibili a terzi
      description: Elenca le informazione di categorizzazione di tutti gli atti opponibili a terzi registrati durante il processo di notifica.
      tags:
      - LegalFacts
      operationId: retrieveNotificationLegalFactsV20
      parameters:
      - $ref: '#/components/parameters/pathIun'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegalFactListV20'
        '400':
          description: Invalid input
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: Not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
    servers:
    - url: https://api.notifichedigitali.it
      description: Ambiente di produzione
    - url: https://api.uat.notifichedigitali.it
      description: Ambiente di collaudo
  /delivery-push/{iun}/legal-facts/{legalFactType}/{legalFactId}:
    get:
      deprecated: true
      summary: Singolo atto opponibile a terzi
      description: Permette di scaricare un atto opponibile a terzi
      tags:
      - LegalFacts
      operationId: retrieveLegalFact
      parameters:
      - $ref: '#/components/parameters/pathIun'
      - $ref: '#/components/parameters/pathLegalFactType'
      - $ref: '#/components/parameters/pathLegalFactId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegalFactDownloadMetadataResponse'
        '400':
          description: Invalid input
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: Not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
    servers:
    - url: https://api.notifichedigitali.it
      description: Ambiente di produzione
    - url: https://api.uat.notifichedigitali.it
      description: Ambiente di collaudo
  /delivery-push/{iun}/download/legal-facts/{legalFactId}:
    get:
      summary: Singolo atto opponibile a terzi
      description: Permette di scaricare un atto opponibile a terzi
      tags:
      - LegalFacts
      operationId: downloadLegalFactById
      parameters:
      - $ref: '#/components/parameters/pathIun'
      - $ref: '#/components/parameters/pathLegalFactId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegalFactDownloadMetadataResponse'
        '400':
          description: Invalid input
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: Not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
    servers:
    - url: https://api.notifichedigitali.it
      description: Ambiente di produzione
    - url: https://api.uat.notifichedigitali.it
      description: Ambiente di collaudo
  /delivery-push/{iun}/legal-facts:
    get:
      deprecated: true
      summary: Elenco atti opponibili a terzi
      description: Elenca le informazione di categorizzazione di tutti gli atti opponibili a terzi registrati durante il processo di notifica.
      tags:
      - LegalFacts
      operationId: retrieveNotificationLegalFacts
      parameters:
      - $ref: '#/components/parameters/pathIun'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegalFactList'
        '400':
          description: Invalid input
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: Not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
    servers:
    - url: https://api.notifichedigitali.it
      description: Ambiente di produzione
    - url: https://api.uat.notifichedigitali.it
      description: Ambiente di collaudo
components:
  parameters:
    pathIun:
      description: Identificativo Univoco Notifica
      name: iun
      in: path
      required: true
      schema:
        type: string
        minLength: 25
        maxLength: 25
        pattern: ^[A-Z]{4}-[A-Z]{4}-[A-Z]{4}-[0-9]{6}-[A-Z]{1}-[0-9]{1}$
    pathLegalFactType:
      description: Categoria dell'atto opponibile a terzi
      name: legalFactType
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/LegalFactCategory'
    pathLegalFactId:
      description: Identificativo dell'atto opponibile a terzi
      name: legalFactId
      in: path
      required: true
      schema:
        type: string
        pattern: ^[ -~]*$
        maxLength: 1024
  schemas:
    LegalFactsId:
      description: Chiavi dei documenti generati durante il processo di consegna cartacea
      type: object
      required:
      - key
      - category
      properties:
        key:
          description: Chiave dell'atto opponibile a terzi generato durante il processo di consegna
          type: string
          pattern: ^(safestorage:\/\/)?[A-Za-z0-9._-]+$
          maxLength: 512
        category:
          $ref: '#/components/schemas/LegalFactCategory'
    LegalFactListElement:
      description: Informazioni relative ad un atto opponibile a terzi
      type: object
      required:
      - iun
      - legalFactsId
      properties:
        taxId:
          description: Valorizzato se l'atto si riferisce a uno specifico destinatario
          type: string
          minLength: 11
          maxLength: 16
          pattern: ^([A-Z]{6}[0-9LMNPQRSTUV]{2}[A-Z]{1}[0-9LMNPQRSTUV]{2}[A-Z]{1}[0-9LMNPQRSTUV]{3}[A-Z]{1})|([0-9]{11})$
        iun:
          description: Identificativo Univoco Notifica a cui l'atto è associato
          type: string
          maxLength: 25
          pattern: ^[A-Z]{4}-[A-Z]{4}-[A-Z]{4}-[0-9]{6}-[A-Z]{1}-[0-9]{1}$
        legalFactsId:
          $ref: '#/components/schemas/LegalFactsId'
    LegalFactCategory:
      title: Tipi di atti opponibili a terzi
      description: "Tipi di atti opponibili a terzi che Piattaforma Notifiche mette a disposizione dei suoi utenti.\n  - _SENDER_ACK_: atto di \"presa in carico\" di una notifica\n  - _DIGITAL_DELIVERY_: ..."
      type: string
      enum:
      - SENDER_ACK
      - DIGITAL_DELIVERY
      - ANALOG_DELIVERY
      - RECIPIENT_ACCESS
      - PEC_RECEIPT
      - ANALOG_FAILURE_DELIVERY
    LegalFactListElementV20:
      description: Informazioni relative ad un atto opponibile a terzi
      type: object
      required:
      - iun
      - legalFactsId
      properties:
        taxId:
          description: Valorizzato se l'atto si riferisce a uno specifico destinatario
          type: string
          minLength: 11
          maxLength: 16
          pattern: ^([A-Z]{6}[0-9LMNPQRSTUV]{2}[A-Z]{1}[0-9LMNPQRSTUV]{2}[A-Z]{1}[0-9LMNPQRSTUV]{3}[A-Z]{1})|([0-9]{11})$
        iun:
          description: Identificativo Univoco Notifica a cui l'atto è associato
          type: string
          maxLength: 25
          pattern: ^[A-Z]{4}-[A-Z]{4}-[A-Z]{4}-[0-9]{6}-[A-Z]{1}-[0-9]{1}$
        legalFactsId:
          $ref: '#/components/schemas/LegalFactsIdV20'
    LegalFactList:
      title: Elenco atti opponibili
      description: Elenco degli atti opponibili a terzi correlati a una notifica
      type: array
      items:
        $ref: '#/components/schemas/LegalFactListElement'
    LegalFactsIdV20:
      description: Chiavi dei documenti generati durante il processo di consegna cartacea
      type: object
      required:
      - key
      - category
      properties:
        key:
          description: Chiave dell'atto opponibile a terzi generato durante il processo di consegna
          type: string
          pattern: ^(safestorage:\/\/)?[A-Za-z0-9._-]+$
          maxLength: 512
        category:
          $ref: '#/components/schemas/LegalFactCategoryV20'
    LegalFactDownloadMetadataResponse:
      title: Url e metadati per il download di un allegato di una notifica
      description: "I due campi più importanti sono __url__ e __retryAfter__. <br/>\n  - __url__ è presente se il file è pronto per essere scaricato ed indica l'url a cui fare GET.\n  - __retryAfter__ indica che il file non è stato archiviato e bisognerà aspettare un numero di\n    secondi non inferiore a quanto indicato dal campo _retryAfter_. <br/>"
      type: object
      required:
      - filename
      - contentLength
      properties:
        filename:
          type: string
        contentLength:
          type: number
          format: decimal32
          example: 54092
          description: dimensione, in byte, del contenuto.
        url:
          type: string
          description: URL preautorizzato a cui effettuare una richiesta GET per ottenere il  contenuto del documento. Presente solo se il documento è pronto per il download.
        retryAfter:
          type: number
          format: decimal32
          description: Stima del numero di secondi da aspettare prima che il contenuto del  documento sia scaricabile.
    Problem:
      properties:
        type:
          description: URI reference of type definition
          type: string
        status:
          description: The HTTP status code generated by the origin server for this occurrence of the problem.
          type: integer
          format: int32
          example: 503
          minimum: 100
          exclusiveMaximum: 600
        title:
          description: A short, summary of the problem type. Written in english and readable
          example: Service Unavailable
          maxLength: 64
          pattern: ^[ -~]{0,64}$
          type: string
        detail:
          description: A human readable explanation of the problem.
          example: Request took too long to complete.
          maxLength: 4096
          pattern: ^.{0,4096}$
          type: string
        traceId:
          description: Internal support identifier associated to error
          example: 123e4567-e89b-12d3-a456-426614174000
          type: string
        timestamp:
          description: date and time referred to UTC
          example: '2022-07-27T12:22:33.444Z'
          type: string
          format: date-time
        errors:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/ProblemError'
      required:
      - status
      - errors
    ProblemError:
      properties:
        code:
          description: Internal code of the error, in human-readable format
          example: PN_PARAMETER_TOO_LONG | PN_PARAMETER_TOO_SHORT | PN_DUPLICATE_ENTRY | etc...
          type: string
        element:
          description: Parameter or request body field name for validation error
          example: body.order.item[2].quantity
          type: string
        detail:
          description: A human readable explanation specific to this occurrence of the problem.
          example: Parameter not valid
          maxLength: 1024
          type: string
      required:
      - code
    LegalFactListV20:
      title: Elenco atti opponibili
      description: Elenco degli atti opponibili a terzi correlati a una notifica
      type: array
      items:
        $ref: '#/components/schemas/LegalFactListElementV20'
    LegalFactCategoryV20:
      title: Tipi di atti opponibili a terzi
      description: "Tipi di atti opponibili a terzi che Piattaforma Notifiche mette a disposizione dei suoi utenti. <br/>\n  - SENDER_ACK  <br/>\n  - DIGITAL_DELIVERY  <br/>\n  - ANALOG_DELIVERY  <br/>\n  - RECIPIENT_ACCESS <br/>\n  - PEC_RECEIPT  <br/>\n  - ANALOG_FAILURE_DELIVERY  <br/>\n  - NOTIFICATION_CANCELLED  <br/>"
      type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
x-refined-from:
- send-b2b-pa-bundle.yaml
- pagopa-send-b2b-pa-openapi.yml