{"openapi":"3.0.2","info":{"description":"Servizi web per l'attivazione e la gestione della Posta Elettronica Certificata (PEC). Questi servizi consentono di registrare una nuova casella di posta certificata, nonché di rinnovare o revocare account esistenti. È inoltre possibile modificare le opzioni della casella di posta, quali lo spazio di archiviazione totale e quello dedicato all’archivio, oppure attivare ed estendere la conservazione a norma di legge. Inoltre, il sistema prevede procedure per la segnalazione di un indirizzo di posta elettronica certificata al Registro delle Imprese. Infine, è possibile utilizzare questi servizi per scaricare e caricare i moduli di attivazione sia per la casella di posta che per il servizio di conservazione a norma di legge.","version":"1.1.0","title":"Pec (Posta Elettronica Certificata)","termsOfService":"https://openapi.it/en/terms-and-conditions","contact":{"url":"https://openapi.it/en/support","name":"Support"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"servers":[{"url":"https://pec.openapi.it","description":"Produzione"},{"url":"https://test.pec.openapi.it","description":"Sandbox"}],"tags":[{"name":"Pec","description":"Metodi che consentono di registrare, attivare e modificare un indirizzo e-mail certificato"},{"name":"Comunica Pec","description":"Metodi che consentono di inviare una posta elettronica certificata al registro delle imprese"},{"name":"Domini","description":"Metodi che consentono di attivare e modificare un dominio certificato"},{"name":"Modulistica","description":"Metodi che consentono di scaricare i moduli necessari per la gestione delle caselle di posta elettronica certificate"}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"BodyPostPec":{"type":"object","properties":{"casella_pec":{"type":"string","description":"l'indirizzo e-mail certificato (PEC)"},"tipo_casella":{"type":"string","description":"type of mailbox. STANDARD/BRONZE/SILVER/GOLD/MASSIVA1-3 vengono fornite tramite InfoCert; DOMICILIODIGITALE/PECMASSIVA vengono fornite tramite Namirial. Il provider viene ricavato da questo valore (più il dominio), non viene scelto separatamente, e determina quali degli altri campi BodyPostPec siano effettivamente applicabili (vedere le relative descrizioni).","enum":["STANDARD","BRONZE","SILVER","GOLD","DOMICILIODIGITALE","PECMASSIVA","MASSIVA1","MASSIVA2","MASSIVA3"]},"tipo_cliente":{"type":"string","description":"il tipo di cliente","enum":["IM","PS","PL","PC","A","PV","X"]},"sottotipo_cliente":{"type":"string","description":"Il sottotipo del cliente. Convalidato rispetto alla raccolta di ricerca \"tipologie\" gestita dal database, non a un elenco fisso: i codici validi dipendono dal \"tipo_cliente\"; consultare lo schema TipologieCliente per le tabelle dei codici relative a ciascun \"tipo_cliente\".","enum":["SI","IN","CM","TE","ES","ME","AL","CF","ED","TM","MA","AR","TL","FI","X","PC","PR","PN","PT","PA","PL","LR","LP","LC","LM","LA","LI"],"x-valori-per-tipo-cliente":{"$ref":"#/components/schemas/TipologieCliente"}},"sottotipo_cliente_altro":{"type":"string","description":"altro sottotipo di cliente"},"nome_richiedente":{"type":"string","description":"nome del richiedente"},"cognome_richiedente":{"type":"string","description":"cognome del richiedente"},"email":{"type":"string","description":"indirizzo e-mail standard del richiedente"},"telefono":{"type":"string","description":"numero di telefono del richiedente"},"cellulare":{"type":"string","description":"numero di cellulare del richiedente"},"codice_fiscale_richiedente":{"type":"string","description":"codice fiscale del richiedente"},"data_nascita_richiedente":{"type":"string","description":"data di nascita del richiedente"},"sesso_richiedente":{"type":"string","description":"sesso del richiedente","enum":["M","F"]},"nazione_nascita_richiedente":{"type":"string","description":"paese di nascita del richiedente"},"comune_nascita_richiedente":{"type":"string","description":"city of birth of the applicant"},"provincia_nascita_richiedente":{"type":"string","description":"province of birth of the applicant"},"denominazione_titolare":{"type":"string","description":"nome del titolare della casella postale. Obbligatorio quando tipo_cliente non è 'PV'."},"cf_piva_titolare":{"type":"string","description":"codice fiscale o partita IVA del titolare della casella postale. Obbligatorio quando tipo_cliente non è 'PV'."},"indirizzo_titolare":{"type":"string","description":"indirizzo del titolare della casella postale"},"comune_titolare":{"type":"string","description":"city of the mailbox holder"},"cap_titolare":{"type":"string","description":"codice postale (CAP) del titolare della casella postale"},"nazione_titolare":{"type":"string","description":"paese del titolare della casella postale"},"provincia_titolare":{"type":"string","description":"province del titolare della casella postale"},"callback":{"$ref":"#/components/schemas/Callback"},"autorinnovo":{"type":"boolean","description":"se impostato su \"true\", consente al sistema di rinnovare automaticamente l'account alla scadenza, tentando di prelevare credito dal portafoglio del titolare","default":false},"tipo_documento":{"type":"string","description":"type di documento di identità","enum":["CARTA_D_IDENTITA","PATENTE","PASSAPORTO"]},"numero_documento":{"type":"string","description":"numero del documento"},"data_scadenza_documento":{"type":"string","description":"data di scadenza del documento"},"documento_rilasciato_da":{"type":"string","description":"autorità che ha rilasciato il documento"},"data_rilascio_documento":{"type":"string","description":"Data di emissione del documento"},"rinnovo_anni":{"type":"integer","description":"anni aggiuntivi oltre al primo anno obbligatorio (0-3); durata totale dell'iscrizione = 1 + rinnovo_anni, ovvero 1-4 anni; valore predefinito: 0","minimum":0,"maximum":3,"default":0},"spazio_disco":{"type":"integer","description":"spazio su disco iniziale in MB (facoltativo; deve essere un multiplo di 1024)"},"spazio_storico":{"type":"integer","description":"spazio iniziale dell'archivio in MB (facoltativo; deve essere un multiplo di 1024)"},"spazio_conservazione":{"type":"integer","description":"spazio iniziale di conservazione in MB (facoltativo; deve essere un multiplo di 512)"},"invio_massivo_pec":{"type":"integer","description":"Solo InfoCert. Limite di invio in blocco (deve essere un multiplo positivo di 50). Non supportato sui dispositivi Namirial."},"phishing_protection":{"type":"boolean","description":"Solo InfoCert. Attiva la protezione anti-phishing al momento della registrazione. Non supportato sui dispositivi Namirial."},"password_protection":{"type":"boolean","description":"Solo InfoCert. Attivare la protezione con password al momento della registrazione. Non supportato sui dispositivi Namirial."},"multiutenza":{"oneOf":[{"type":"boolean","description":"Solo Namirial. Il parametro \"true\" attiva o disattiva il servizio multiutente al momento della registrazione."},{"type":"array","description":"InfoCert: ogni voce crea un account slave distinto e gestito individualmente. Namirial: non è possibile creare utenti individuali — anche un array non vuoto è sufficiente per attivare il servizio; in caso contrario, il contenuto viene ignorato.","items":{"type":"object","properties":{"nome":{"type":"string"},"cognome":{"type":"string"},"descrizione":{"type":"string"},"email_gestione_password":{"type":"string"}},"required":["nome","cognome","email_gestione_password"]}}]},"note":{"type":"string","description":"note interne"}},"required":["casella_pec","tipo_casella","tipo_cliente","nome_richiedente","cognome_richiedente","email","telefono","codice_fiscale_richiedente","data_nascita_richiedente","sesso_richiedente","nazione_nascita_richiedente","indirizzo_titolare","comune_titolare","cap_titolare","nazione_titolare","provincia_titolare"]},"BodyPostDominio":{"type":"object","required":["dominio","fornitore"],"properties":{"dominio":{"type":"string","description":"Il nome di dominio da attivare (ad es. example.com)","example":"testdominio.legalmail.it"},"fornitore":{"type":"string","enum":["infocert","namirial"],"description":"Il fornitore del servizio","example":"infocert"},"anni":{"type":"integer","description":"Numero di anni per i quali viene acquistato il dominio (solo per l'attivazione iniziale, da 1 a 3)","default":1,"example":1,"enum":[1,2,3]},"numero_pec":{"type":"integer","description":"Numero di caselle PEC acquistate per il dominio","default":0,"example":1},"note":{"type":"string","description":"Nota interna in formato testo libero che viene memorizzata nel dominio. Non viene mai restituita dai metodi GET /dominio o GET /dominio/{id} (viene rimossa solo da queste due risposte)."},"data_scadenza":{"type":"string","description":"Data di scadenza esplicita (gg/mm/aaaa). Se specificata, prevale completamente sul calcolo basato sugli “anni” e la verifica della validità da 1 a 3 anni viene ignorata.","example":"02/02/2027"},"tipo_cliente":{"type":"string","description":"[Solo Namirial] Type di cliente. Impostato obbligatoriamente su \"IM\" se assente o su \"PV\" — un'attivazione di dominio non può mai essere effettivamente registrata come \"PV\", pertanto denominazione_titolare/cf_piva_titolare sono di fatto sempre obbligatori per Namirial.","enum":["IM","PS","PL","PC","A","PV","X"],"example":"IM"},"nome_richiedente":{"type":"string","description":"[Solo Namirial] Nome del richiedente. Obbligatorio."},"cognome_richiedente":{"type":"string","description":"[Solo Namirial] Cognome del richiedente. Obbligatorio."},"codice_fiscale_richiedente":{"type":"string","description":"[Solo per Namirial] Codice fiscale del richiedente. Obbligatorio."},"data_nascita_richiedente":{"type":"string","description":"[Solo Namirial] Data di nascita del richiedente (gg/mm/aaaa). Obbligatoria per l'attivazione del dominio, indipendentemente dal valore di tipo_cliente."},"sesso_richiedente":{"type":"string","enum":["M","F"],"description":"[Solo Namirial] Sesso del richiedente. Obbligatorio per l'attivazione del dominio, indipendentemente dal valore di “tipo_cliente”."},"email":{"type":"string","description":"[Solo Namirial] Indirizzo e-mail del richiedente. Obbligatorio."},"cellulare":{"type":"string","description":"[Solo Namirial] Numero di cellulare del richiedente. Obbligatorio."},"indirizzo_titolare":{"type":"string","description":"[Solo Namirial] Indirizzo del titolare. Obbligatorio."},"comune_titolare":{"type":"string","description":"[Solo Namirial] City of the holder. Obbligatorio."},"cap_titolare":{"type":"string","description":"[Solo Namirial] Codice postale del titolare. Obbligatorio."},"provincia_titolare":{"type":"string","description":"[Solo Namirial] Provincia del titolare. Obbligatorio."},"nazione_titolare":{"type":"string","description":"[Solo Namirial] Paese del titolare. Obbligatorio."},"denominazione_titolare":{"type":"string","description":"[Solo Namirial] Nome dell'azienda/entità. Obbligatorio nella pratica: il campo \"tipo_cliente\" non può mai rimanere \"PV\" per l'attivazione di un dominio."},"cf_piva_titolare":{"type":"string","description":"[Solo Namirial] Codice fiscale o partita IVA del titolare. Richiesto sempre nella pratica: il campo “tipo_cliente” non può mai rimanere “PV” per l’attivazione di un dominio."},"comune_nascita_richiedente":{"type":"string","description":"[Solo Namirial] City of birth of the applicant. Obbligatorio per l'attivazione del dominio, indipendentemente dal valore di tipo_cliente."},"provincia_nascita_richiedente":{"type":"string","description":"[Solo Namirial] Provincia di nascita del richiedente."},"nazione_nascita_richiedente":{"type":"string","description":"[Solo Namirial] Paese di nascita del richiedente. Obbligatorio per l'attivazione del dominio, indipendentemente dal valore di tipo_cliente."},"tipo_documento":{"type":"string","enum":["CARTA_D_IDENTITA","PASSAPORTO"],"description":"[Solo Namirial] Tipo di documento di identità. Obbligatorio. La patente di guida (PATENTE) NON è accettata per la registrazione del dominio (a differenza dell'attivazione della casella PEC, che invece la accetta)."},"numero_documento":{"type":"string","description":"[Solo Namirial] Numero del documento. Obbligatorio."},"data_scadenza_documento":{"type":"string","description":"[Solo Namirial] Data di scadenza del documento (gg/mm/aaaa). Campo obbligatorio."},"documento_rilasciato_da":{"type":"string","description":"[Solo Namirial] Ente emittente del documento. Obbligatorio."},"data_rilascio_documento":{"type":"string","description":"[Solo Namirial] Data di emissione del documento (gg/mm/aaaa). Obbligatorio."},"callback":{"$ref":"#/components/schemas/Callback"}}},"Dominio":{"type":"object","description":"I metodi GET/POST/PATCH/DELETE restituiscono tutti il record del dominio così come è memorizzato in MongoDB, praticamente senza modifiche (vengono eliminati solo alcuni campi; si vedano i singoli endpoint). Su alcuni domini InfoCert ciò include campi non scritti da alcun percorso di codice API attuale — 'anagrafica_sincronizzata', 'pec_attive', 'pec_totali', 'sottotipo_cliente', 'telefono' (tutti documentati di seguito) — oltre ai valori in lingua italiana 'dns'/'config'/'certif' (ad es. 'CORRETTO'/'ERRATO') generati dall’integrazione XML di InfoCert (DominioInfoCert::sincronizza / InfocertDominiClient::getStatoDominio), a differenza dei valori in inglese “OK”/“KO” generati dall’integrazione rest utilizzata al momento dell’attivazione iniziale.","properties":{"id":{"type":"string","description":"ID dominio","example":"69806bcce09fb76c6b0fef0b"},"dominio":{"type":"string","description":"Nome di dominio","example":"testdominio.legalmail.it"},"fornitore":{"type":"string","enum":["infocert","namirial"],"description":"Il fornitore del servizio","example":"infocert"},"owner":{"type":"string","description":"Nome utente del proprietario del dominio","example":"mail@domain.com"},"stato_fornitore":{"type":"string","enum":["OK","KO","PENDING"],"description":"Stato del dominio dal punto di vista del provider. Il valore \"PENDING\" non viene attualmente generato da alcun percorso di codice in questo repository (vengono effettivamente impostati solo \"OK\" e \"KO\") — è mantenuto nell'enumerazione come valore documentato ma attualmente inutilizzato/riservato.","example":"OK"},"dns":{"type":"string","description":"Stato della configurazione DNS fornita dal provider","example":"OK"},"config":{"type":"string","description":"Stato della configurazione del server fornito dal provider","example":"OK"},"certif":{"type":"string","description":"Stato della certificazione fornito dal fornitore","example":"missing"},"note":{"type":"string","description":"Nota interna a testo libero. Non è mai presente nelle risposte GET /dominio o GET /dominio/{id} (viene rimossa); può essere presente nelle risposte POST/PATCH/DELETE e GET .../rinnovo."},"record_mx":{"type":"string","description":"Record MX associato al dominio"},"tipo_dominio":{"type":"string","enum":["interno","esterno"],"description":"Type di dominio (interno o esterno)","example":"interno"},"stato":{"type":"string","enum":["registrato","in_attesa_certificazione","evaso","revocato"],"description":"Stato di elaborazione interna","example":"registrato"},"data_scadenza":{"type":"string","description":"Data di scadenza (gg/mm/aaaa)","example":"02/02/2027"},"data_certificazione":{"type":"string","description":"Data di certificazione (gg/mm/aaaa)","example":"02/02/2026"},"timestamp":{"$ref":"#/components/schemas/Timestamp"},"id_ordine":{"type":"string","description":"ID ordine associato all'attivazione. Non è mai presente nelle risposte GET /dominio o GET /dominio/{id} (viene rimosso); è presente nelle risposte POST/PATCH/DELETE e GET .../rinnovo.","example":"62558f"},"autorinnovo":{"type":"boolean","default":false,"description":"Se vero, il dominio verrà rinnovato automaticamente","example":false},"anni":{"type":"integer","description":"Numero di anni per i quali è stato acquistato il dominio","example":1},"numero_pec":{"type":"integer","description":"Numero di caselle PEC acquistate per il dominio","default":0,"example":1},"callback":{"$ref":"#/components/schemas/Callback"},"tipo_cliente":{"type":"string","description":"[Solo domini Namirial] Tipo di cliente","enum":["IM","PS","PL","PC","A","PV","X"],"example":"IM"},"nome_richiedente":{"type":"string","description":"[Solo domini Namirial] Nome del richiedente"},"cognome_richiedente":{"type":"string","description":"[Solo domini Namirial] Cognome del richiedente"},"codice_fiscale_richiedente":{"type":"string","description":"[Solo domini Namirial] Codice fiscale del richiedente"},"email":{"type":"string","description":"[Solo domini Namirial] Indirizzo e-mail del richiedente"},"cellulare":{"type":"string","description":"[Solo domini Namirial] Numero di cellulare del richiedente"},"indirizzo_titolare":{"type":"string","description":"[Solo domini Namirial] Indirizzo del titolare"},"comune_titolare":{"type":"string","description":"[Solo domini Namirial] City of the holder"},"cap_titolare":{"type":"string","description":"[Solo domini Namirial] Codice postale del titolare"},"provincia_titolare":{"type":"string","description":"[Solo domini Namirial] Provincia del titolare"},"nazione_titolare":{"type":"string","description":"[Solo domini Namirial] Paese del titolare"},"denominazione_titolare":{"type":"string","description":"[Solo domini Namirial] Nome dell'azienda/entità"},"cf_piva_titolare":{"type":"string","description":"[Solo domini Namirial] Codice fiscale o partita IVA del titolare"},"data_nascita_richiedente":{"type":"string","description":"[Solo domini Namirial] Data di nascita del richiedente (gg/mm/aaaa)"},"sesso_richiedente":{"type":"string","enum":["M","F"],"description":"[Solo domini Namirial] Sesso del richiedente"},"comune_nascita_richiedente":{"type":"string","description":"[Solo domini Namirial] City of birth of the applicant"},"provincia_nascita_richiedente":{"type":"string","description":"[Solo domini Namirial] Provincia di nascita del richiedente"},"nazione_nascita_richiedente":{"type":"string","description":"[Solo domini Namirial] Paese di nascita del richiedente"},"documenti_attivazione":{"type":"array","items":{"type":"string"},"description":"[Solo domini Namirial] Documenti di attivazione inviati tramite PATCH /dominio/{id}"},"tipo_documento":{"type":"string","enum":["CARTA_D_IDENTITA","PATENTE","PASSAPORTO"],"description":"[Solo domini Namirial] Type di documento di identità del richiedente. La dicitura \"PATENTE\" può ancora comparire sui domini attivati prima che questo campo venisse limitato a CARTA_D_IDENTITA|PASSAPORTO per le nuove attivazioni (vedi BodyPostDominio.tipo_documento)."},"numero_documento":{"type":"string","description":"[Solo domini Namirial] Numero del documento"},"data_scadenza_documento":{"type":"string","description":"[Solo domini Namirial] Data di scadenza del documento (gg/mm/aaaa)"},"documento_rilasciato_da":{"type":"string","description":"[Solo domini Namirial] Ente emittente del documento"},"data_rilascio_documento":{"type":"string","description":"[Solo domini Namirial] Data di emissione del documento (gg/mm/aaaa)"},"sottotipo_cliente":{"type":"string","description":"Rilevato su alcuni domini InfoCert. Non è stato generato da alcun percorso di codice API attuale."},"telefono":{"type":"string","description":"Numero di telefono di contatto presente su alcuni domini InfoCert. Non è previsto da nessun percorso di codice API attuale (il flusso di attivazione raccoglie solo il \"cellulare\")."},"anagrafica_sincronizzata":{"type":"boolean","description":"Segnalazione rilevata su alcuni domini InfoCert. Non generata da alcun percorso di codice API attuale."},"pec_attive":{"type":"integer","description":"Conteggio delle caselle di posta PEC attive su questo dominio, visibile su alcuni domini InfoCert. Non viene generato da alcun percorso di codice API attuale. Non è da confondere con \"numero_pec\", che viene impostato dall'API."},"pec_totali":{"type":"integer","description":"Conteggio totale delle caselle di posta PEC presenti in questo dominio, visibile su alcuni domini InfoCert. Non è generato da alcun percorso di codice API attuale. Non è lo stesso di “numero_pec”, che viene impostato dall’API."}}},"BodyPostComunicaPec":{"type":"object","properties":{"casella_pec":{"type":"string","description":"l'indirizzo e-mail certificato (PEC)"},"pec_amministratore":{"type":"boolean","description":"se vero, la casella di posta appartiene all'amministratore aziendale","default":false},"cf":{"type":"string","description":"codice fiscale"},"nome":{"type":"string","description":"nome"},"cognome":{"type":"string","description":"cognome"},"qualifica":{"type":"string","description":"qualifica del proprietario","enum":["AMMINISTRATORE","COMMISSARIO_GIUDIZIARIO","CURATORE_FALLIMENTARE","LEGALE_RAPPRESENTANTE","LIQUIDATORE","SOCIO","TITOLARE"]},"email":{"type":"string","description":"indirizzo e-mail del proprietario"},"cellulare":{"type":"string","description":"cellulare del proprietario"},"ragione_sociale":{"type":"string","description":"nome dell'azienda"},"cf_piva":{"type":"string","description":"codice fiscale o partita IVA dell'azienda"},"comune":{"type":"string","description":"comune in cui ha sede l'azienda"},"provincia":{"type":"string","description":"province in cui ha sede l'azienda"},"callback":{"$ref":"#/components/schemas/Callback"}},"required":["casella_pec","cf","nome","cognome","qualifica","email","cellulare","ragione_sociale","cf_piva","comune","provincia"]},"BodyPostMultiutenza":{"type":"object","properties":{"nome":{"type":"string","description":"nome"},"cognome":{"type":"string","description":"cognome"},"descrizione":{"type":"string","description":"descrizione. Obbligatoria per le caselle di posta InfoCert (STANDARD/BRONZE/SILVER/GOLD). Non viene affatto verificata per le caselle di posta Namirial (DOMICILIODIGITALE/PECMASSIVA), la cui funzione multiutente è un semplice flag di attivazione/disattivazione."},"email_gestione_password":{"type":"string","description":"indirizzo e-mail dell'utente"}},"required":["nome","cognome","email_gestione_password"]},"TipologieCliente":{"type":"object","properties":{"IM":{"type":"string","description":"Impresa","enum":["SI - SERVIZI IMPRESE","IN - INFORMATICA","CM - COMMERCIO","TE - TELECOMUNICAZIONI","ES - EDITORIA STAMPA","ME - MECCANICA ELETTRICA","AL - ALIMENTARE","CF - CHIMICA FARMACEUTICA","ED - EDILIZIA","TM - TESSILE MODA","MA - MOBILI ARREDAMENTI","AR - ALBERGHI RISTORANTI","TL - TRASPOSRTI LOGISTICA","FI - FINANZA","X - ALTRO"]},"PS":{"type":"string","description":"Professionista","enum":["PC - COMMERCIALISTA","PR - RAGIONIERE","PN - NOTAIO","PT - TRIBUTARISTA","PA - AVVOCATO","PL - CONSULENTE LAVORO","X - ALTRO"]},"PL":{"type":"string","description":"Amministrazione pubblica locale","enum":["LR - REGIONE","LP - PROVINCIA","LC - COMUNE","LM - COMUNITA MONTANA","LA - ASL","LI - CCIAA","X - ALTRO"]},"PC":{"type":"string","description":"Amministrazione pubblica centrale"},"A":{"type":"string","description":"Associazione"},"PV":{"type":"string","description":"Privato"},"X":{"type":"string","description":"Altro"}}},"Casella":{"type":"object","properties":{"casella_pec":{"type":"string","description":"l'indirizzo e-mail certificato (PEC)"},"tipo_casella":{"type":"string","description":"type of mailbox","enum":["STANDARD","BRONZE","SILVER","GOLD","DOMICILIODIGITALE","PECMASSIVA","MASSIVA1","MASSIVA2","MASSIVA3"]},"tipo_cliente":{"type":"string","description":"il tipo di cliente"},"sottotipo_cliente":{"type":"string","description":"il sottotipo di cliente"},"sottotipo_cliente_altro":{"type":"string","description":"altro sottotipo di cliente"},"nome_richiedente":{"type":"string","description":"nome del richiedente"},"cognome_richiedente":{"type":"string","description":"cognome del richiedente"},"email":{"type":"string","description":"indirizzo e-mail standard del richiedente"},"telefono":{"type":"string","description":"numero di telefono del richiedente"},"cellulare":{"type":"string","description":"numero di cellulare del richiedente"},"codice_fiscale_richiedente":{"type":"string","description":"codice fiscale del richiedente"},"data_nascita_richiedente":{"type":"string","description":"data di nascita del richiedente"},"sesso_richiedente":{"type":"string","description":"sesso del richiedente"},"nazione_nascita_richiedente":{"type":"string","description":"paese di nascita del richiedente"},"comune_nascita_richiedente":{"type":"string","description":"city of birth of the applicant"},"provincia_nascita_richiedente":{"type":"string","description":"province of birth of the applicant"},"denominazione_titolare":{"type":"string","description":"nome del titolare della casella postale. Obbligatorio quando tipo_cliente non è 'PV'."},"cf_piva_titolare":{"type":"string","description":"codice fiscale o partita IVA del titolare della casella postale. Obbligatorio quando tipo_cliente non è 'PV'."},"indirizzo_titolare":{"type":"string","description":"indirizzo del titolare della casella postale"},"comune_titolare":{"type":"string","description":"city of the mailbox holder"},"cap_titolare":{"type":"string","description":"codice postale (CAP) del titolare della casella postale"},"nazione_titolare":{"type":"string","description":"paese del titolare della casella postale"},"provincia_titolare":{"type":"string","description":"province of the mailbox holder"},"callback":{"$ref":"#/components/schemas/Callback"},"dominio":{"type":"string","description":"il nome di dominio associato alla casella di posta PEC"},"owner":{"type":"string","description":"identificativo del proprietario"},"timestamp":{"$ref":"#/components/schemas/Timestamp"},"cod_attivazione":{"type":"string","description":"codice di attivazione della casella di posta"},"uid":{"type":"string","description":"identificatore univoco della casella di posta o della richiesta"},"conservazione":{"type":"boolean","description":"indica se la conservazione elettronica a norma è attiva"},"data_scadenza":{"type":"string","description":"data di scadenza del servizio/casella di posta"},"descrizione":{"type":"string","description":"descrizione"},"sms":{"type":"boolean","description":"[indica se le notifiche via SMS sono attive]"},"spazio_conservazione":{"type":"integer","description":"spazio di archiviazione assegnato per la conservazione prevista dalla legge, in MB"},"spazio_disco":{"type":"integer","description":"spazio su disco totale assegnato alla casella di posta in MB)"},"spazio_storico":{"type":"integer","description":"spazio di archiviazione assegnato ai dati storici/all'archivio in MB"},"stato":{"type":"string","enum":["registrata","in_evasione","evasa","revocata","chiusa","documenti_errati"],"description":"stato attuale della casella di posta/richiesta"},"storico":{"type":"boolean","description":"indica se è attiva la funzione di accesso ai dati storici o di archiviazione"},"documenti_attivazione":{"type":"array","items":{"type":"string"},"description":"serie di stringhe  per i documenti di attivazione"},"data_attivazione":{"type":"string","description":"data di attivazione della casella di posta"},"documenti_conservazione":{"type":"array","items":{"type":"string"},"description":"matrice di stringhe per i documenti di conservazione"},"multiutenza":{"oneOf":[{"type":"boolean","description":"Caselle Namirial (DOMICILIODIGITALE/PECMASSIVA): vero una volta attivato il servizio multiutente"},{"type":"array","items":{"$ref":"#/components/schemas/Utenza"},"description":"Box InfoCert: elenco degli utenti secondari"}]},"rinnovo_anni":{"type":"integer","description":"anni aggiuntivi oltre al primo anno obbligatorio, come indicato al momento dell’iscrizione (0-3)"},"id":{"type":"string","description":"ID oggetto"},"autorinnovo":{"type":"boolean","description":"se impostato su \"true\", consente al sistema di rinnovare automaticamente l'account alla scadenza, tentando di prelevare credito dal portafoglio del titolare"},"tipo_documento":{"type":"string","enum":["CARTA_D_IDENTITA","PATENTE","PASSAPORTO"],"description":"type di documento di identità"},"numero_documento":{"type":"string","description":"numero del documento"},"data_scadenza_documento":{"type":"string","description":"data di scadenza del documento"},"documento_rilasciato_da":{"type":"string","description":"autorità che ha rilasciato il documento"},"data_rilascio_documento":{"type":"string","description":"Data di emissione del documento"},"phishing_protection":{"type":"boolean","description":"indica se il componente aggiuntivo di protezione dal phishing è attivo"},"password_protection":{"type":"boolean","description":"indica se il componente aggiuntivo di protezione con password è attivo"},"invio_massivo":{"type":"boolean","description":"indica se il servizio di invio massivo è attivo"},"invio_massivo_pec":{"type":"integer","description":"quota di invio in massa in numero di messaggi"},"invio_massivo_stat":{"type":"object","description":"statistiche sull'utilizzo dell'invio in massa (presenti solo quando invio_massivo è attivo)","properties":{"totale":{"type":"integer","description":"quota totale"},"consumati":{"type":"integer","description":"messaggi letti"},"rimanenti":{"type":"integer","description":"messaggi rimanenti"}}}}},"Callback":{"type":"object","description":"Configurazione standardizzata del callback. Consente di ricevere notifiche relative agli aggiornamenti di stato delle richieste asincrone.","properties":{"method":{"type":"string","description":"Specificare il metodo di callback. Se impostato su 'POST', verrà avviata una richiesta HTTP POST standard con Content-Type application/x-www-form-urlencoded. I dati JSON verranno codificati in una coppia chiave-valore denominata \"data\" (personalizzabile tramite il parametro \"field\"). Se impostato su \"JSON\", verrà effettuata una richiesta HTTP POST diretta con Content-Type application/json e il corpo JSON non formattato.","enum":["POST","JSON"],"default":"JSON"},"field":{"type":"string","nullable":true,"description":"Funziona con method='POST'. Determina il nome del parametro inviato nel corpo della richiesta POST. Valore nullo quando method='JSON' (non applicabile).","example":"data","default":"data"},"url":{"type":"string","format":"uri","description":"Un URL valido in grado di gestire le richieste POST. Per gli endpoint autenticati, utilizzare il parametro \"headers\". Il timeout massimo è di 30 secondi. Se è impostato il parametro \"retry\", il sistema riprova fino a quando non viene ricevuto un codice di stato 200.","example":"https://www.mysite.com/myEndpoint"},"retry":{"type":"integer","description":"Numero massimo di tentativi di ripetizione. I tentativi di ripetizione vengono effettuati solo in caso di errori temporanei (ad es. 502, 503) o problemi di rete, con backoff esponenziale. Il valore massimo è 5.","example":3,"minimum":0,"maximum":5,"default":0},"headers":{"type":"object","additionalProperties":{"type":"string"},"description":"Intestazioni HTTP da inviare con la richiesta di callback. Utili per l'autenticazione (autenticazione di base, autenticazione bearer) o per metadati personalizzati.","example":{"session_id":"9834r5fh589494"}},"custom":{"description":"Dati aggiuntivi da includere nel payload della callback, accessibili tramite la chiave \"custom\" nel corpo della callback. Può essere qualsiasi valore JSON (oggetto, array, stringa, numero).","example":{"my_custom_id":"123456789"}}}},"Timestamp":{"type":"object","properties":{"registrazione":{"type":"integer","description":"ora di registrazione/creazione"},"ultima_modifica":{"type":"integer","description":"ora dell'ultima modifica"},"evasione":{"type":"integer","description":"tempo di completamento/risoluzione"},"certificazione":{"type":"integer","description":"tempo di certificazione/attivazione"},"scadenza":{"type":"integer","description":"data di scadenza/termine ultimo"},"revoca":{"type":"integer","description":"tempo di revoca"}}},"RichiesteComunicazionePec":{"type":"object","properties":{"id":{"type":"string","description":"ID oggetto"},"casella_pec":{"type":"string","description":"l'indirizzo e-mail certificato (PEC)"},"stato":{"type":"string","description":"Stato della richiesta","enum":["codice_in_richiesta","in_attesa_di_documenti","documenti_caricati","annullata"]},"timestamp":{"type":"integer"},"owner":{"type":"string","description":"identificativo del proprietario"}}},"RichiestaComunicazionePec":{"type":"object","properties":{"casella_pec":{"type":"string","description":"l'indirizzo e-mail certificato (PEC), con le lettere in minuscolo dal lato server"},"pec_amministratore":{"type":"boolean","description":"se vero, la casella di posta appartiene all'amministratore aziendale","default":false},"cf":{"type":"string","description":"codice fiscale, maiuscolo lato server"},"nome":{"type":"string","description":"nome"},"cognome":{"type":"string","description":"cognome"},"qualifica":{"type":"string","description":"qualifica del richiedente, in maiuscolo lato server","enum":["AMMINISTRATORE","COMMISSARIO_GIUDIZIARIO","CURATORE_FALLIMENTARE","LEGALE_RAPPRESENTANTE","LIQUIDATORE","SOCIO","TITOLARE"]},"email":{"type":"string","description":"indirizzo e-mail del proprietario"},"cellulare":{"type":"string","description":"cellulare del proprietario"},"ragione_sociale":{"type":"string","description":"nome dell'azienda"},"cf_piva":{"type":"string","description":"codice fiscale o partita IVA dell'azienda, convertito in maiuscolo lato server"},"comune":{"type":"string","description":"comune in cui ha sede l’azienda"},"provincia":{"type":"string","description":"province in cui ha sede la società"},"callback":{"$ref":"#/components/schemas/Callback"},"stato":{"type":"string","enum":["codice_in_richiesta","in_attesa_di_documenti","documenti_caricati","annullata"]},"codice_registro_imprese":{"type":"string"},"documenti_registro_imprese":{"type":"array","items":{"type":"string"}},"owner":{"type":"string","description":"identificativo del proprietario"},"timestamp":{"type":"integer"},"id":{"type":"string","description":"ID oggetto"}}},"Utenza":{"type":"object","properties":{"nome":{"type":"string","description":"nome"},"cognome":{"type":"string","description":"cognome"},"descrizione":{"type":"string","description":"note"},"email_gestione_password":{"type":"string","description":"indirizzo e-mail utilizzato per la gestione delle password"},"id_utenza":{"type":"string","description":"identificativo dell'account utente"},"timestamp":{"type":"object","properties":{"attivazione":{"type":"integer","description":"data e ora di attivazione dell'account"}}},"userid":{"type":"string","description":"identificativo di accesso dell'utente"}}},"Caselle":{"type":"object","properties":{"casella_pec":{"type":"string","description":"l'indirizzo e-mail certificato (PEC)"},"tipo_casella":{"type":"string","description":"type of mailbox","enum":["STANDARD","BRONZE","SILVER","GOLD","DOMICILIODIGITALE","PECMASSIVA","MASSIVA1","MASSIVA2","MASSIVA3"]},"owner":{"type":"string","description":"identificativo del proprietario"},"timestamp":{"$ref":"#/components/schemas/Timestamp"},"data_scadenza":{"type":"string","description":"Data di scadenza"},"stato":{"type":"string","description":"stato di elaborazione","enum":["registrata","in_evasione","evasa","revocata","chiusa","documenti_errati"]},"id":{"type":"string","description":"ID oggetto"}}}}},"paths":{"/dominio":{"get":{"tags":["Domini"],"summary":"Elenca tutti i domini associati all'account","operationId":"getDominiList","responses":{"200":{"description":"Elenco dei domini","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Dominio"}}}}}}},"404":{"description":"Nessun dominio trovato","content":{"application/json":{"example":{"success":false,"message":"no domains linked to this account","error":701,"data":null}}}}}},"post":{"tags":["Domini"],"summary":"Attiva un nuovo dominio certificato","operationId":"postDominio","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BodyPostDominio"},"examples":{"infocert":{"summary":"Dominio InfoCert","description":"InfoCert richiede solo il dominio, il provider, la durata/quota e, facoltativamente, una nota o un numero di richiamata; nessuno dei campi relativi al richiedente o al titolare è pertinente.","value":{"dominio":"testdominio.legalmail.it","fornitore":"infocert","anni":1,"numero_pec":1}},"namirial":{"summary":"Dominio Namirial","description":"Namirial richiede i dati completi del richiedente e del titolare/della società per l'attivazione.","value":{"dominio":"testdominio.pecmassiva.com","fornitore":"namirial","anni":1,"numero_pec":1,"tipo_cliente":"IM","denominazione_titolare":"esempio srl","cf_piva_titolare":"01234567890","indirizzo_titolare":"via verdi 20","comune_titolare":"roma","cap_titolare":"00042","provincia_titolare":"rm","nazione_titolare":"it","nome_richiedente":"mario","cognome_richiedente":"rossi","codice_fiscale_richiedente":"RSSXXXXXXXX56E","data_nascita_richiedente":"11/04/1982","sesso_richiedente":"M","comune_nascita_richiedente":"roma","provincia_nascita_richiedente":"RM","nazione_nascita_richiedente":"it","email":"mail@domain.com","cellulare":"3401234567","tipo_documento":"CARTA_D_IDENTITA","numero_documento":"CA00000AA","data_rilascio_documento":"01/01/2020","data_scadenza_documento":"01/01/2030","documento_rilasciato_da":"Comune di Roma"}}}}}},"responses":{"200":{"description":"Avviata l'attivazione del dominio","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Dominio"}}},"examples":{"infocert":{"value":{"data":{"dominio":"testdominio.legalmail.it","fornitore":"infocert","owner":"gcloud-tests@openapi.it","stato_fornitore":"KO","dns":"OK","config":"KO","certif":"KO","tipo_dominio":"interno","stato":"registrato","data_scadenza":"02/02/2027","timestamp":{"registrazione":1770023882,"scadenza":1801559882,"ultima_modifica":1770023884},"anni":1,"numero_pec":1,"id_ordine":"62558f","autorinnovo":false,"callback":{"url":"https://www.mysite.it/callback.php","method":"POST","field":"data"},"id":"69806bcce09fb76c6b0fef0b"}}},"namirial":{"value":{"data":{"dominio":"testdominio.pecmassiva.com","fornitore":"namirial","owner":"gcloud-tests@openapi.it","stato_fornitore":"KO","dns":"OK","config":"KO","certif":"KO","tipo_dominio":"interno","stato":"registrato","data_scadenza":"02/02/2027","timestamp":{"registrazione":1770023882,"scadenza":1801559882,"ultima_modifica":1770023884},"anni":1,"numero_pec":1,"id_ordine":"62558f","autorinnovo":false,"tipo_cliente":"IM","denominazione_titolare":"esempio srl","cf_piva_titolare":"01234567890","indirizzo_titolare":"via verdi 20","comune_titolare":"roma","cap_titolare":"00042","provincia_titolare":"rm","nazione_titolare":"it","nome_richiedente":"mario","cognome_richiedente":"rossi","codice_fiscale_richiedente":"RSSXXXXXXXX56E","data_nascita_richiedente":"11/04/1982","sesso_richiedente":"M","comune_nascita_richiedente":"roma","provincia_nascita_richiedente":"RM","nazione_nascita_richiedente":"it","email":"mail@domain.com","cellulare":"3401234567","tipo_documento":"CARTA_D_IDENTITA","numero_documento":"CA00000AA","data_rilascio_documento":"01/01/2020","data_scadenza_documento":"01/01/2030","documento_rilasciato_da":"Comune di Roma","id":"69806bcce09fb76c6b0fef0c"}}}}}}},"402":{"description":"Pagamento richiesto","content":{"application/json":{"example":{"success":false,"message":"Insufficient Credit in Wallet: 182.03","error":403,"data":null}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"examples":{"already_present_infocert":{"value":{"success":false,"message":"domain already present in the system","error":712,"data":null}},"invalid_domain_infocert":{"value":{"success":false,"message":"domain not valid","error":733,"data":null}},"invalid_domain_namirial":{"value":{"success":false,"message":"invalid domain format","error":725,"data":null}},"reserved_name":{"value":{"success":false,"message":"domain cannot contain reserved provider names","error":723,"data":null}},"legalmail_namirial":{"value":{"success":false,"message":"legalmail.it subdomains cannot be registered with Namirial","error":724,"data":null}},"provider_not_supported":{"value":{"success":false,"message":"provider not supported or not identified: infocert, namirial","error":708,"data":null}}}}}},"409":{"description":"Conflitto","content":{"application/json":{"example":{"success":false,"message":"domain already registered","error":732,"data":null}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"example":{"success":false,"message":"tipo_documento not valid for domain: CARTA_D_IDENTITA|PASSAPORTO","error":723,"data":null}}}},"428":{"description":"Precondition Required. A seconda del \"fornitore\" e dei campi inviati, potrebbero essere restituiti anche ulteriori errori di convalida dei campi relativi al richiedente/titolare Namirial provenienti dal validatore PEC condiviso (codici di errore 360-406, vedi POST /pec).","content":{"application/json":{"examples":{"domain_required":{"value":{"success":false,"message":"domain required","error":703,"data":null}},"provider_required":{"value":{"success":false,"message":"provider required","error":706,"data":null}},"no_mx":{"value":{"success":false,"message":"Invalid domain: no MX record found...","error":714,"data":null}},"unreachable":{"value":{"success":false,"message":"The domain '...' is unreachable","error":715,"data":null}},"anagrafici_richiedente_required":{"value":{"success":false,"message":"required for domain: data_nascita_richiedente, sesso_richiedente, comune_nascita_richiedente, nazione_nascita_richiedente","error":733,"data":null}},"doc_fields_required":{"value":{"success":false,"message":"tipo_documento required for domain","error":720,"data":null}},"denominazione_required":{"value":{"success":false,"message":"denominazione_titolare required for professional domains","error":721,"data":null}},"cf_piva_required":{"value":{"success":false,"message":"cf_piva_titolare required for professional domains","error":722,"data":null}},"anni_range":{"value":{"success":false,"message":"anni must be between 1 and 3","error":738,"data":null}}}}}}}}},"/dominio/{id}":{"get":{"tags":["Domini"],"summary":"Ottieni informazioni su un dominio specifico","operationId":"getDominio","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"69806bcce09fb76c6b0fef0b"},"description":"L'ID del dominio"}],"responses":{"200":{"description":"Dettagli del dominio","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Dominio"}}},"examples":{"infocert":{"summary":"Dominio InfoCert","value":{"data":{"dominio":"pec.esempiosrl.it","fornitore":"infocert","owner":"gcloud-tests@openapi.it","stato_fornitore":"OK","dns":"CORRETTO","config":"CORRETTO","certif":"CORRETTO","tipo_dominio":"esterno","stato":"evaso","numero_pec":0,"data_scadenza":"09/04/2027","data_certificazione":"09/04/2013","timestamp":{"registrazione":1365465600,"certificazione":1365465600,"scadenza":1807228800,"ultima_modifica":1770023884},"callback":{"method":"JSON","url":"https://www.esempiosrl.it/callback/domini-certificati","field":null,"retry":2,"custom":{},"headers":{}},"autorinnovo":false,"anagrafica_sincronizzata":true,"cap_titolare":"00100","cellulare":"3491234567","cf_piva_titolare":"01234567890","codice_fiscale_richiedente":"RSSMRA80A01H501U","cognome_richiedente":"Rossi","comune_titolare":"Roma","data_nascita_richiedente":"01/01/1980","denominazione_titolare":"Esempio S.r.l.","email":"m.rossi@esempiosrl.it","indirizzo_titolare":"Via Roma 1","nazione_nascita_richiedente":"IT","nazione_titolare":"Italiana","nome_richiedente":"Mario","pec_attive":0,"pec_totali":1,"provincia_titolare":"RM","sesso_richiedente":"M","sottotipo_cliente":"SI","telefono":"0612345678","tipo_cliente":"IM","id":"65f1a2b3c4d5e6f7a8b9c0d1"}}},"namirial":{"summary":"Dominio Namirial","value":{"data":{"dominio":"pec.esempioclienti.com","fornitore":"namirial","owner":"gcloud-tests@openapi.it","stato_fornitore":"OK","dns":"OK","config":"OK","certif":"OK","tipo_dominio":"esterno","stato":"evaso","data_scadenza":"12/06/2027","timestamp":{"registrazione":1781277767,"scadenza":1812813767,"ultima_modifica":1781280020,"certificazione":1781280020},"anni":1,"numero_pec":0,"autorinnovo":false,"callback":{"method":"JSON","url":"https://www.esempioclienti.com/callback/domini","field":null,"retry":0,"custom":{},"headers":{}},"tipo_cliente":"IM","nome_richiedente":"Giulia","cognome_richiedente":"Bianchi","codice_fiscale_richiedente":"BNCGLI85M42H501Z","email":"g.bianchi@example.com","cellulare":"+447700900123","indirizzo_titolare":"12 Example Street","comune_titolare":"London","cap_titolare":"EC1A 1AA","provincia_titolare":"EE","nazione_titolare":"REG","denominazione_titolare":"Example Company Ltd","cf_piva_titolare":"98765432100","data_nascita_richiedente":"","sesso_richiedente":"","comune_nascita_richiedente":"","provincia_nascita_richiedente":"","tipo_documento":"PATENTE","numero_documento":"AB1234567CD","data_scadenza_documento":"20/04/2027","documento_rilasciato_da":"DVLA","data_rilascio_documento":"12/08/2020","data_certificazione":"12/06/2026","id":"65f1a2b3c4d5e6f7a8b9c0d2"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"success":false,"message":"Wrong id","error":739,"data":null}}}},"404":{"description":"Not Found","content":{"application/json":{"example":{"success":false,"message":"no domain found","error":702,"data":null}}}}}},"patch":{"tags":["Domini"],"summary":"Aggiornare un dominio certificato","description":"Aggiorna un dominio certificato. Accetta documenti di attivazione (solo Namirial — InfoCert restituisce l’errore 730) e/o rinnova o riattiva il dominio per un determinato numero di anni (da 1 a 10). È necessario specificare almeno uno tra «documenti» e «anni». Se il dominio si trova nello stato «revocato» e viene specificato «anni», il dominio viene riattivato.","operationId":"patchDominio","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"69806bcce09fb76c6b0fef0b"},"description":"L'ID del dominio"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"documenti":{"type":"array","items":{"oneOf":[{"type":"string","description":"base64_encode(contenuto del file)"},{"type":"object","properties":{"file":{"type":"string","description":"base64_encode(contenuto del file)"}}}],"description":"Sono ammessi file in formato PDF (application/pdf) o P7M (application/octet-stream); ogni voce può essere una stringa base64 semplice o un oggetto con una chiave \"file\""},"description":"Documenti di attivazione. Solo per Namirial: avvia l'invio dei documenti tramite e-mail certificata PEC al fornitore. Se il dominio si trova attualmente nello stato \"revocato\", i documenti inviati vengono scartati in modo silenzioso e il dominio viene invece riattivato (vedere il comportamento \"anni\" di seguito)."},"anni":{"type":"integer","description":"Numero di anni per il rinnovo o la riattivazione del dominio (1–10). Se il dominio è nello stato \"revocato\", questa operazione lo riattiva (il valore predefinito è 1 anno se omesso); in caso contrario, rinnova la scadenza attuale.","minimum":1,"maximum":10,"example":1}}},"examples":{"renew_years":{"summary":"Rinnova o riattiva il dominio per N anni","value":{"anni":1}},"upload_documents":{"summary":"Caricare solo i documenti di attivazione (solo Namirial)","value":{"documenti":["JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PAovVHlwZSAvUGFnZQovTWVkaWFCb3ggWzAgMCA1OTUgODQyXQo..."]}},"renew_and_upload":{"summary":"Rinnova il dominio e carica i documenti di attivazione (solo Namirial)","value":{"anni":1,"documenti":["JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PAovVHlwZSAvUGFnZQovTWVkaWFCb3ggWzAgMCA1OTUgODQyXQo..."]}}}}}},"responses":{"200":{"description":"Dominio aggiornato","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Dominio"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"examples":{"documenti_not_supported":{"value":{"success":false,"message":"documenti not supported for InfoCert domains","error":730,"data":null}},"invalid_id":{"value":{"success":false,"message":"invalid form or id format. Did you pass a subset as an ID?","error":711,"data":null}}}}}},"402":{"description":"Pagamento richiesto","content":{"application/json":{"example":{"success":false,"message":"Insufficient Credit in Wallet: 182.03","error":403,"data":null}}}},"404":{"description":"Not Found","content":{"application/json":{"example":{"success":false,"message":"no domain found","error":705,"data":null}}}},"428":{"description":"Precondition Required","content":{"application/json":{"examples":{"id_required":{"value":{"success":false,"message":"id required","error":734,"data":null}},"payload_missing":{"value":{"success":false,"message":"payload must include 'documenti' and/or 'anni'","error":735,"data":null}},"wrong_state_for_documents":{"value":{"success":false,"message":"documents can only be submitted when domain is in 'registrato' state","error":737,"data":null}},"anni_range":{"value":{"success":false,"message":"years must be between 1 and 10","error":717,"data":null}}}}}}}},"delete":{"tags":["Domini"],"summary":"Revocare un dominio certificato","description":"Revoca il dominio e le caselle di posta PEC ad esso associate. Le caselle di posta già nello stato \"evasa\" vengono revocate tramite il provider (con notifica di callback); le caselle di posta non ancora attive (qualsiasi altro stato tranne \"revocata\") vengono eliminate temporaneamente e portate direttamente allo stato \"revocata\" senza contattare il provider.","operationId":"deleteDominio","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"69806bcce09fb76c6b0fef0b"},"description":"L'ID del dominio da revocare"}],"responses":{"200":{"description":"Dominio revocato","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/Dominio"}}},"example":{"success":true,"message":"Domain and associated boxes revoked","data":{"dominio":"pec.testgestionale.com","fornitore":"infocert","owner":"gcloud-tests@openapi.it","stato_fornitore":"OK","dns":"OK","config":"OK","certif":"OK","tipo_dominio":"esterno","stato":"revocato","data_scadenza":"13/03/2054","data_certificazione":"13/03/2026","timestamp":{"registrazione":1773401265,"scadenza":2657014065,"ultima_modifica":1774273311,"certificazione":1773401405,"revoca":1774273558},"autorinnovo":false,"anni":1,"numero_pec":3,"id_ordine":"1a54cf","callback":{"url":"https://www.mysite.it/callback.php"},"id":"69b3f4b1d0747173230c4448"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"success":false,"message":"invalid form or id format. Did you pass a subset as an ID?","error":711,"data":null}}}},"404":{"description":"Not Found","content":{"application/json":{"example":{"success":false,"message":"no domain found","error":705,"data":null}}}},"428":{"description":"Precondition Required","content":{"application/json":{"examples":{"id_required":{"value":{"success":false,"message":"id required","error":704,"data":null}},"already_revoked_infocert":{"value":{"success":false,"message":"your domain has already been revoked","error":716,"data":null}},"already_revoked_namirial":{"value":{"success":false,"message":"your domain has already been revoked","error":736,"data":null}}}}}}}}},"/dominio/{id}/rinnovo":{"get":{"tags":["Domini"],"summary":"Rinnovare o riattivare un dominio certificato","description":"Rinnova il dominio per il numero di anni specificato (da 1 a 3). Se il dominio si trova nello stato \"revocato\", lo riattiva e ripristina le caselle PEC associate non scadute.","operationId":"renewDominio","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"69806bcce09fb76c6b0fef0b"},"description":"L'ID del dominio"},{"name":"anni","in":"query","schema":{"type":"integer","default":1,"minimum":1,"maximum":3},"description":"Numero di anni per il rinnovo o la riattivazione (1–3). Valore predefinito: 1."}],"responses":{"200":{"description":"Risultato del rinnovo o della riattivazione","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Dominio"}}},"example":{"data":{"dominio":"pec.testgestionale.com","fornitore":"infocert","owner":"gcloud-tests@openapi.it","stato_fornitore":"OK","dns":"OK","config":"OK","certif":"OK","tipo_dominio":"esterno","stato":"evaso","data_scadenza":"13/03/2054","data_certificazione":"13/03/2026","timestamp":{"registrazione":1773401265,"scadenza":2657014065,"ultima_modifica":1774273311,"certificazione":1773401405},"autorinnovo":false,"anni":1,"numero_pec":3,"id_ordine":"1a54cf","callback":{"url":"https://www.mysite.it/callback.php"},"id":"69b3f4b1d0747173230c4448"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"success":false,"message":"invalid form or id format. Did you pass a subset as an ID?","error":711,"data":null}}}},"402":{"description":"Pagamento richiesto","content":{"application/json":{"example":{"success":false,"message":"Insufficient Credit in Wallet: 182.03","error":403,"data":null}}}},"404":{"description":"Not Found","content":{"application/json":{"example":{"success":false,"message":"no domain found","error":705,"data":null}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"example":{"success":false,"message":"anni must be between 1 and 3","error":713,"data":null}}}}}}},"/dominio/{id}/modulo_attivazione":{"get":{"tags":["Modulistica"],"summary":"Scarica il modulo di attivazione del dominio","description":"Scarica il modulo di attivazione in formato PDF per un dominio certificato. Disponibile solo per i domini Namirial. Una volta compilato e firmato, caricalo utilizzando il comando PATCH /dominio/{id} con il campo \"documenti\".","operationId":"getDominioModuloAttivazione","parameters":[{"name":"id","in":"path","required":true,"description":"L'ID del dominio","schema":{"type":"string","example":"69806bcce09fb76c6b0fef0b"}}],"responses":{"200":{"description":"Un file PDF","headers":{"Content-Disposition":{"schema":{"type":"string"},"example":"inline;filename=modulo_attivazione_testdominio.legalmail.it.pdf","description":"Solo Namirial — il nome del file viene generato dinamicamente dal nome di dominio; la modalità di invio è \"inline\", non \"allegato\""}},"content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request","content":{"application/json":{"examples":{"unsupported_provider":{"value":{"success":false,"message":"modulo_attivazione non supportato per questo fornitore","error":731,"data":null}},"invalid_id":{"value":{"success":false,"message":"invalid form or id format. Did you pass a subset as an ID?","error":711,"data":null}}}}}},"404":{"description":"Not Found","content":{"application/json":{"example":{"success":false,"message":"no domain found","error":705,"data":null}}}}}}},"/domini_pec/{dominio}":{"get":{"tags":["Domini"],"summary":"Verifica del dominio","description":"Questo metodo consente di verificare se un dominio è idoneo a inviare o ricevere una PEC","parameters":[{"name":"dominio","in":"path","description":"Dominio","required":true,"schema":{"type":"string","example":"legalmail.it"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"},"description":"Nell'implementazione attuale è sempre un array vuoto"},"success":{"type":"boolean","description":"Esito dell'operazione (vero/falso)."},"message":{"type":"string","description":"messaggio di errore"},"error":{"type":"integer","description":"codice di errore"}}},"example":{"data":[],"success":true,"message":"legalmail.it found!","error":null}}}},"204":{"description":"Nessun contenuto"},"402":{"description":"Pagamento richiesto","content":{"application/json":{"example":{"success":false,"message":"Insufficient Credit in Wallet: 182.03","error":403,"data":null}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"example":{"success":false,"message":"domain not valid","error":709,"data":null}}}},"428":{"description":"Precondition Required","content":{"application/json":{"example":{"success":false,"message":"domain required","error":700,"data":null}}}},"503":{"description":"Servizio non disponibile","content":{"application/json":{"example":{"success":false,"message":"service temporarily unavailable","error":710,"data":null}}}}}}},"/verifica_pec/{pec}":{"get":{"tags":["Pec"],"summary":"Disponibilità di una casella di posta elettronica certificata","description":"Questo metodo consente di verificare la disponibilità di una casella di posta elettronica certificata. È in grado di verificare la disponibilità solo delle caselle di posta relative ai domini configurati e gestiti dal sistema. Per i domini non gestiti, restituirà un ERROR poiché non è possibile verificarne l'esistenza.","parameters":[{"name":"pec","in":"path","description":"Casella di posta elettronica","required":true,"schema":{"type":"string","example":"prova_pec@legalmail.it"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"available":{"type":"boolean","description":"Indica se l'indirizzo e-mail può essere registrato"}}},"success":{"type":"boolean","description":"Esito dell'operazione (vero/falso)."},"message":{"type":"string","description":"messaggio di errore"},"error":{"type":"integer","description":"codice di errore"}}},"example":{"data":{"available":true},"success":true,"message":"","error":null}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"example":{"success":false,"message":"invalid casella_pec","error":213,"data":null}}}},"428":{"description":"Precondition Required","content":{"application/json":{"examples":{"casella_pec_required":{"value":{"success":false,"message":"casella_pec required","error":212,"data":null}},"unmanaged_domain":{"value":{"success":false,"message":"we cannot know if the mailbox exists for unmanaged domains","error":253,"data":null}}}}}}}}},"/pec":{"get":{"tags":["Pec"],"summary":"Elenco delle tue caselle di posta elettronica certificate","description":"Questo metodo ti mostra l'elenco delle caselle di posta elettronica certificate associate al tuo account","parameters":[{"name":"skip","in":"query","description":"Facoltativo. Numero di elementi da saltare per l'impaginazione. Se non specificato, il valore predefinito è 0.","required":false,"schema":{"type":"integer","example":0}},{"name":"limit","in":"query","description":"Facoltativo. Numero massimo di elementi da restituire. Se non specificato, il valore predefinito è 100.","required":false,"schema":{"type":"integer","example":100}},{"name":"expiring","in":"query","description":"Facoltativo. Numero di giorni (da 1 a 365). Se specificato, restituisce solo le caselle di posta nello stato \"evasa\" la cui scadenza cade in quel giorno di calendario (dalle 00:00:00 alle 23:59:59, oggi + N giorni), ordinate in ordine crescente per data di scadenza.","required":false,"schema":{"type":"integer","minimum":1,"maximum":365,"example":30}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Caselle"}},"total_count":{"type":"integer","description":"Numero totale di caselle di posta PEC corrispondenti alla query, senza tenere conto della paginazione con skip/limit."},"success":{"type":"boolean","description":"Esito dell'operazione (vero/falso)."},"message":{"type":"string","description":"messaggio di errore"},"error":{"type":"integer","description":"codice di errore"}}},"example":{"data":[{"id":"6040e4613a716838dc4eee0e","casella_pec":"mypec@testcert.legalmail.it","tipo_casella":"BRONZE","stato":"revocata","data_scadenza":"04/03/2022","timestamp":{"registrazione":1614865504,"ultima_modifica":1614868403,"evasione":1614868312,"scadenza":1646391493,"revoca":1614868400},"owner":"mail@domain.com"},{"id":"6040c9df3a716838dc4eede4","casella_pec":"yourpec@testcert.legalmail.it","tipo_casella":"STANDARD","stato":"evasa","data_scadenza":"04/03/2022","timestamp":{"registrazione":1614858718,"ultima_modifica":1614859181,"evasione":1614859181,"scadenza":1646391493},"owner":"mail@domain.com"}],"total_count":2,"success":true,"message":"","error":null}}}},"404":{"description":"Not Found","content":{"application/json":{"example":{"success":false,"message":"no PEC linked to this account","error":200,"data":null}}}},"428":{"description":"Precondition Required","content":{"application/json":{"example":{"success":false,"message":"expiring must be between 1 and 365","error":262,"data":null}}}}}},"post":{"tags":["Pec"],"summary":"Registra una nuova casella di posta certificata","description":"Questo metodo consente di registrare una nuova casella di posta certificata. \n\nSe non si dispone di un proprio dominio certificato, l'indirizzo della casella di posta deve necessariamente essere composto da: \n\n- 'box_name'@legalmail.it (es. provapec@legalmail.it) per le caselle di posta STANDARD, BRONZE, SILVER e GOLD; \n\n- 'box_name'@domiciliodigitale.com (es. provapec@domiciliodigitale.com) per le caselle DOMICILIODIGITALE; \n\n- 'box_name'@pecmassiva.com (es. provapec@pecmassiva.com) per la casella PECMASSIVA. \n\nIn sandbox deve essere: 'box_name'@testcert.legalmail.it (es. provapec@testcert.legalmail.it) oppure 'box_name'@test.domiciliodigitale.com (es. provapec@test.domiciliodigitale.com).","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BodyPostPec"},"examples":{"infocert":{"summary":"Esempio InfoCert","value":{"casella_pec":"yourpec@testcert.legalmail.it","tipo_casella":"bronze","tipo_cliente":"PV","sottotipo_cliente":"SI","sottotipo_cliente_altro":"","nome_richiedente":"mario","cognome_richiedente":"rossi","email":"mail@domain.com","telefono":"0548798569","cellulare":"3401234567","codice_fiscale_richiedente":"RSSXXXXXXXX56E","data_nascita_richiedente":"11/04/1982","sesso_richiedente":"M","nazione_nascita_richiedente":"it","comune_nascita_richiedente":"roma","provincia_nascita_richiedente":"RM","denominazione_titolare":"","cf_piva_titolare":"","indirizzo_titolare":"via verdi 20","comune_titolare":"roma","cap_titolare":"00042","nazione_titolare":"it","provincia_titolare":"rm","tipo_documento":"CARTA_D_IDENTITA","numero_documento":"CA00000AA","data_rilascio_documento":"01/01/2020","data_scadenza_documento":"01/01/2030","documento_rilasciato_da":"Comune di Roma","autorinnovo":false,"rinnovo_anni":1,"spazio_disco":1024,"spazio_storico":1024,"spazio_conservazione":512,"invio_massivo_pec":50,"phishing_protection":false,"password_protection":false,"multiutenza":[{"nome":"luca","cognome":"bianchi","descrizione":"collaboratore","email_gestione_password":"luca.bianchi@mail.com"}],"note":"note interne","callback":{"url":"https://your_domain.it/your_callback.php","custom":{"my_order_id":"123456"}}}},"namirial":{"summary":"Esempio di Namirial","value":{"casella_pec":"yourpec@domiciliodigitale.com","tipo_casella":"DOMICILIODIGITALE","tipo_cliente":"PV","nome_richiedente":"mario","cognome_richiedente":"rossi","email":"mail@domain.com","telefono":"0548798569","cellulare":"3401234567","codice_fiscale_richiedente":"RSSXXXXXXXX56E","data_nascita_richiedente":"11/04/1982","sesso_richiedente":"M","nazione_nascita_richiedente":"it","comune_nascita_richiedente":"roma","provincia_nascita_richiedente":"RM","indirizzo_titolare":"via verdi 20","comune_titolare":"roma","cap_titolare":"00042","nazione_titolare":"it","provincia_titolare":"rm","tipo_documento":"CARTA_D_IDENTITA","numero_documento":"CA00000AA","data_rilascio_documento":"01/01/2020","data_scadenza_documento":"01/01/2030","documento_rilasciato_da":"Comune di Roma","autorinnovo":false,"rinnovo_anni":1,"spazio_disco":1024,"spazio_storico":1024,"spazio_conservazione":1024,"multiutenza":true,"note":"note interne","callback":{"url":"https://your_domain.it/your_callback.php","custom":{"my_order_id":"123456"}}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Casella"},"success":{"type":"boolean","description":"Esito dell'operazione (vero/falso)."},"message":{"type":"string","description":"messaggio di errore"},"error":{"type":"integer","description":"codice di errore"}}},"example":{"data":{"casella_pec":"yourpec@testcert.legalmail.it","tipo_casella":"BRONZE","tipo_cliente":"PV","sottotipo_cliente":"SI","sottotipo_cliente_altro":"","nome_richiedente":"mario","cognome_richiedente":"rossi","email":"mail@domain.com","telefono":"0548798569","cellulare":"3401234567","codice_fiscale_richiedente":"RSSXXXXXXXX56E","data_nascita_richiedente":"11/04/1982","sesso_richiedente":"M","nazione_nascita_richiedente":"IT","comune_nascita_richiedente":"roma","provincia_nascita_richiedente":"RM","denominazione_titolare":"","cf_piva_titolare":"","indirizzo_titolare":"via verdi 20","comune_titolare":"roma","cap_titolare":"00042","nazione_titolare":"IT","provincia_titolare":"rm","tipo_documento":"CARTA_D_IDENTITA","numero_documento":"CA00000AA","data_rilascio_documento":"01/01/2020","data_scadenza_documento":"01/01/2030","documento_rilasciato_da":"Comune di Roma","callback":{"url":"https://your_domain.it/your_callback.php","custom":{"my_order_id":"123456"}},"dominio":"testcert.legalmail.it","owner":"mail@domain.com","timestamp":{"registrazione":1615199724,"ultima_modifica":1615199726},"cod_attivazione":"10174594","uid":"MA178634","conservazione":false,"data_scadenza":"","descrizione":"yourpec@testcert.legalmail.it","sms":false,"spazio_conservazione":0,"spazio_disco":2048,"spazio_storico":3072,"stato":"registrata","storico":false,"autorinnovo":false,"phishing_protection":false,"password_protection":false,"invio_massivo":false,"invio_massivo_pec":0,"id":"6045fdee3a716847a978a471"},"success":true,"message":"","error":null}}}},"402":{"description":"Pagamento richiesto","content":{"application/json":{"example":{"success":false,"message":"Insufficient Credit in Wallet: 182.03","error":262,"data":null}}}},"404":{"description":"Not Found","content":{"application/json":{"example":{"success":false,"message":"the domain testcert.legalmail.it is non-existent in the system or belongs to someone else","error":506,"data":null}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"examples":{"date_not_valid":{"value":{"success":false,"message":"data_nascita_richiedente not valid, accepted format: dd/mm/yyyy","error":568,"data":null}},"tipo_casella_not_valid":{"value":{"success":false,"message":"tipo_casella not valid: STANDARD|BRONZE|SILVER|GOLD|DOMICILIODIGITALE|PECMASSIVA|MASSIVA1|MASSIVA2|MASSIVA3","error":505,"data":null}},"cf_piva_titolare_not_valid":{"value":{"success":false,"message":"cf_piva_titolare not valid","error":576,"data":null}},"tipo_documento_not_valid_namirial":{"value":{"success":false,"message":"tipo_documento not valid: CARTA_D_IDENTITA|PATENTE|PASSAPORTO","error":641,"data":null}}}}}},"428":{"description":"Precondition Required","content":{"application/json":{"examples":{"tipo_casella_required":{"value":{"success":false,"message":"tipo_casella required","error":504,"data":null}},"casella_pec_required":{"value":{"success":false,"message":"casella_pec required","error":647,"data":null}},"already_in_db":{"value":{"success":false,"message":"yourpec@testcert.legalmail.it not available (already exists in database)","error":502,"data":null}},"not_available_at_provider":{"value":{"success":false,"message":"Box not available","error":503,"data":null}},"domain_revocato":{"value":{"success":false,"message":"the domain testcert.legalmail.it has been revoked","error":507,"data":null}},"denominazione_titolare_required":{"value":{"success":false,"message":"denominazione_titolare required","error":574,"data":null}},"cf_piva_titolare_required":{"value":{"success":false,"message":"cf_piva_titolare required","error":575,"data":null}}}}}}}}},"/pec/{id}":{"get":{"tags":["Pec"],"summary":"Indirizzo e-mail certificato specifico","description":"Questo metodo restituisce l'indirizzo e-mail certificato associato all'ID","parameters":[{"name":"id","in":"path","description":"Pec id","required":true,"schema":{"type":"string","example":"6040e4613a716838dc4eee0e"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Casella"},"success":{"type":"boolean","description":"Esito positivo dell'operazione (vero/falso)."},"message":{"type":"string","description":"messaggio di errore"},"error":{"type":"integer","description":"codice di errore"}}},"example":{"data":{"casella_pec":"yourpec@testcert.legalmail.it","tipo_casella":"BRONZE","tipo_cliente":"PV","sottotipo_cliente":"SI","sottotipo_cliente_altro":"","nome_richiedente":"mario","cognome_richiedente":"rossi","email":"mail@domain.com","telefono":"0548798569","cellulare":"3401234567","codice_fiscale_richiedente":"RSSXXXXXXXX56E","data_nascita_richiedente":"11/04/1982","sesso_richiedente":"M","nazione_nascita_richiedente":"IT","comune_nascita_richiedente":"roma","provincia_nascita_richiedente":"RM","denominazione_titolare":"","cf_piva_titolare":"","indirizzo_titolare":"via verdi 20","comune_titolare":"roma","cap_titolare":"00042","nazione_titolare":"IT","provincia_titolare":"rm","tipo_documento":"CARTA_D_IDENTITA","numero_documento":"CA00000AA","data_rilascio_documento":"01/01/2020","data_scadenza_documento":"01/01/2030","documento_rilasciato_da":"Comune di Roma","callback":{"url":"https://your_domain.it/your_callback.php","custom":{"my_order_id":"123456"}},"dominio":"testcert.legalmail.it","owner":"mail@domain.com","timestamp":{"registrazione":1614865504,"ultima_modifica":1614868403,"evasione":1614868312,"scadenza":1646391493,"revoca":1614868400},"cod_attivazione":"10173956","uid":"MA177987","conservazione":true,"data_scadenza":"04/03/2022","data_attivazione":"04/03/2021","descrizione":"yourpec@testcert.legalmail.it","sms":true,"spazio_conservazione":512,"spazio_disco":3072,"spazio_storico":3072,"stato":"revocata","storico":true,"autorinnovo":false,"phishing_protection":true,"password_protection":false,"invio_massivo":true,"invio_massivo_pec":100,"invio_massivo_stat":{"totale":100,"consumati":23,"rimanenti":77},"documenti_attivazione":["6040e4613a716838dc4eee0e_0_attivazione.pdf","6040e4613a716838dc4eee0e_1_attivazione.pdf"],"documenti_conservazione":["6040e4613a716838dc4eee0e_0_conservazione.pdf","6040e4613a716838dc4eee0e_1_conservazione.pdf"],"multiutenza":[{"nome":"luca","cognome":"bianchi","descrizione":"prima utenza","email_gestione_password":"mail@domain.com","id_utenza":"6040e4613a716838dc4eee0e_0","timestamp":{"attivazione":1614868138},"userid":"MA177993"}],"id":"6040e4613a716838dc4eee0e"},"success":true,"message":"","error":null}}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"success":false,"message":"Wrong id","error":201,"data":null}}}},"404":{"description":"Not Found","content":{"application/json":{"example":{"success":false,"message":"no pec found","error":202,"data":null}}}}}},"delete":{"tags":["Pec"],"summary":"Revoca del Pec","description":"Questo metodo consente di revocare l'indirizzo e-mail certificato specifico associato all'ID","parameters":[{"name":"id","in":"path","description":"Pec id","required":true,"schema":{"type":"string","example":"6040e4613a716838dc4eee0e"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Casella"},"success":{"type":"boolean","description":"Esito dell'operazione (vero/falso)."},"message":{"type":"string","description":"messaggio di errore"},"error":{"type":"integer","description":"codice di errore"}}},"example":{"data":{"casella_pec":"yourpec@testcert.legalmail.it","tipo_casella":"BRONZE","tipo_cliente":"PV","sottotipo_cliente":"","sottotipo_cliente_altro":"","nome_richiedente":"mario","cognome_richiedente":"rossi","email":"mail@domain.com","telefono":"0548798569","codice_fiscale_richiedente":"RSSXXXXXXXX56E","data_nascita_richiedente":"11/04/1982","sesso_richiedente":"M","nazione_nascita_richiedente":"IT","provincia_nascita_richiedente":"RM","denominazione_titolare":"","cf_piva_titolare":"","indirizzo_titolare":"via verdi 20","comune_titolare":"roma","cap_titolare":"00042","nazione_titolare":"IT","provincia_titolare":"rm","callback":{"url":"https://your_domain.it/your_callback.php"},"dominio":"testcert.legalmail.it","owner":"mail@domain.com","timestamp":{"registrazione":1614865504,"ultima_modifica":1614868403,"evasione":1614868312,"scadenza":1646391493,"revoca":1614868400},"cellulare":"","comune_nascita_richiedente":"","cod_attivazione":"10173956","uid":"MA177987","conservazione":true,"data_scadenza":"04/03/2022","descrizione":"yourpec@testcert.legalmail.it","sms":true,"spazio_conservazione":512,"spazio_disco":3072,"spazio_storico":3072,"stato":"revocata","storico":true,"documenti_attivazione":["6040e4613a716838dc4eee0e_0_attivazione.pdf","6040e4613a716838dc4eee0e_1_attivazione.pdf"],"data_attivazione":"04/03/2021","documenti_conservazione":["6040e4613a716838dc4eee0e_0_conservazione.pdf","6040e4613a716838dc4eee0e_1_conservazione.pdf"],"multiutenza":[{"nome":"luca","cognome":"bianchi","descrizione":"prima utenza","email_gestione_password":"mail@domain.com","id_utenza":"6040e4613a716838dc4eee0e_0","timestamp":{"attivazione":1614868138},"userid":"MA177993"}],"id":"6040e4613a716838dc4eee0e","autorinnovo":false},"success":true,"message":"","error":null}}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"success":false,"message":"Wrong id","error":236,"data":null}}}},"404":{"description":"Not Found","content":{"application/json":{"example":{"success":false,"message":"no pec found","error":237,"data":null}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"examples":{"already_revoked_infocert":{"value":{"success":false,"message":"your pec has already been revoked","error":532,"data":null}},"already_revoked_namirial":{"value":{"success":false,"message":"your pec has already been revoked","error":593,"data":null}}}}}},"428":{"description":"Precondition Required","content":{"application/json":{"examples":{"wrong_stato_infocert":{"value":{"success":false,"message":"you can revoke the pec only if it is active","error":533,"data":null}},"wrong_stato_namirial":{"value":{"success":false,"message":"you can revoke the pec only if it is active","error":594,"data":null}}}}}}}},"patch":{"tags":["Pec"],"summary":"Operazioni PEC combinate","description":"Eseguire una o più operazioni su una casella PEC in un’unica chiamata con un unico addebito: caricare i documenti di attivazione, rinnovare, passare a un tipo di casella superiore, modificare lo spazio di archiviazione/le opzioni, attivare la conservazione e/o aggiungere account multiutente. È necessario specificare almeno un’operazione. L’attivazione (ModuloAttivazione) richiede lo stato «registrata» o «documenti_errati»; tutte le altre operazioni richiedono lo stato «evasa» (per il rinnovo è accettato anche lo stato «revocata»). Diversi campi sono specifici di InfoCert: 'upgrade_casella' fallisce sempre su Namirial (ERROR 236, nessun livello a cui effettuare l’aggiornamento), mentre 'phishing_protection'/'password_protection'/'invio_massivo_pec' non hanno alcun effetto su tale piattaforma. Anche «multiutenza» si comporta in modo diverso a seconda del provider (un vero e proprio elenco per utente su InfoCert contro un unico servizio on/off su Namirial, senza gestione individuale degli utenti). Si vedano le descrizioni dei campi qui sotto e l’esempio «combined_namirial».","parameters":[{"name":"id","in":"path","description":"Pec id","required":true,"schema":{"type":"string","example":"6045fdee3a716847a978a471"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"documenti":{"type":"array","description":"Documenti da caricare; ogni elemento deve contenere il campo \"tipo\" (ModuloAttivazione|richiestaConservazione) e il campo \"file\" (PDF codificato in base64). Questa procedura si limita a preparare i documenti: l’attivazione effettiva da parte del fornitore viene effettuata in un secondo momento da un operatore, non tramite questa API. Per «richiestaConservazione»: InfoCert richiede solo 1 documento; Namirial ne richiede esattamente 2, in ordine (1° = contratto di conservazione, 2° = informativa sulla privacy) prima che la conservazione possa essere effettivamente attivata.","items":{"type":"object","properties":{"tipo":{"type":"string","enum":["ModuloAttivazione","richiestaConservazione"]},"file":{"type":"string","description":"contenuto PDF codificato in base64"}},"required":["tipo","file"]}},"rinnovo_anni":{"type":"integer","description":"numero di anni per il rinnovo (1-3)","minimum":1,"maximum":3},"upgrade_casella":{"type":"string","description":"Solo InfoCert. Aggiornare il tipo di account (sono consentiti solo gli aggiornamenti, a uno dei livelli di InfoCert). L’operazione fallisce sempre sugli account Namirial (DOMICILIODIGITALE/PECMASSIVA — ERROR 236, poiché non dispongono di livelli di aggiornamento).","enum":["STANDARD","BRONZE","SILVER","GOLD"]},"spazio_disco":{"oneOf":[{"type":"string","example":"+1024"},{"type":"integer","example":2048}],"description":"spazio su disco in MB. Il prefisso \"+\" aggiunge al valore corrente (ad es. \"+1024\"); un numero intero senza prefisso indica il valore assoluto. Deve essere un multiplo di 1024."},"spazio_storico":{"oneOf":[{"type":"string","example":"+1024"},{"type":"integer","example":1024}],"description":"Spazio di archiviazione in MB. Il prefisso \"+\" aggiunge al valore corrente; un numero intero senza prefisso indica il valore assoluto. Deve essere un multiplo di 1024."},"spazio_conservazione":{"oneOf":[{"type":"string","example":"+512"},{"type":"integer","example":512}],"description":"spazio di conservazione in MB. Il prefisso \"+\" aggiunge al valore corrente; un numero intero senza prefisso indica il valore assoluto. Deve essere un multiplo di 512."},"phishing_protection":{"type":"boolean","description":"Solo InfoCert. Attiva la protezione contro il phishing (unidirezionale). Non supportata sui dispositivi Namirial: su questi non ha alcun effetto."},"password_protection":{"type":"boolean","description":"Solo InfoCert. Attivare la protezione con password (unidirezionale). Non supportata sui dispositivi Namirial: in quel caso non ha alcun effetto."},"invio_massivo_pec":{"type":"integer","description":"Solo InfoCert. Quota di invio in blocco da aggiungere (deve essere un multiplo positivo di 50). Non supportato sui server Namirial."},"multiutenza":{"oneOf":[{"type":"boolean","description":"Solo Namirial. \"true\" attiva/disattiva il servizio multiutente."},{"type":"array","description":"InfoCert: ogni voce crea un account slave distinto e gestito individualmente (fino a un massimo di 25 in totale, fatturati per utente). Namirial: non è possibile creare singoli utenti — per attivare il servizio è sufficiente anche un array vuoto; in caso contrario, i contenuti vengono ignorati.","items":{"type":"object","properties":{"nome":{"type":"string"},"cognome":{"type":"string"},"descrizione":{"type":"string"},"email_gestione_password":{"type":"string"}},"required":["nome","cognome","email_gestione_password"]}}]}}},"examples":{"combined_infocert":{"summary":"Esempio InfoCert","value":{"documenti":[{"tipo":"ModuloAttivazione","file":"JVBERi0xLjQKJ..."},{"tipo":"richiestaConservazione","file":"JVBERi0xLjQKJ..."}],"rinnovo_anni":1,"upgrade_casella":"SILVER","spazio_disco":"+1024","spazio_storico":"2048","spazio_conservazione":"512","invio_massivo_pec":50,"phishing_protection":true,"password_protection":true,"multiutenza":[{"nome":"Mario","cognome":"Rossi","descrizione":"Collaboratore","email_gestione_password":"mario.rossi@email.it"}]}},"combined_namirial":{"summary":"Esempio di Namirial","value":{"documenti":[{"tipo":"ModuloAttivazione","file":"JVBERi0xLjQKJ..."},{"tipo":"richiestaConservazione","file":"JVBERi0xLjQKJ...(contratto conservazione)"},{"tipo":"richiestaConservazione","file":"JVBERi0xLjQKJ...(informativa privacy)"}],"rinnovo_anni":1,"spazio_disco":"+1024","spazio_storico":"2048","spazio_conservazione":"1024","multiutenza":true}}}}}},"responses":{"200":{"description":"OK — dati sincronizzati della casella più elenco delle operazioni eseguite","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Casella"},"operazioni_eseguite":{"type":"array","description":"operazioni eseguite: attivazione, rinnovo, upgrade_casella, modifica, conservazione, multiutenza","items":{"type":"string"}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"example":{"data":{"casella_pec":"yourpec@testcert.legalmail.it","tipo_casella":"BRONZE","stato":"evasa","spazio_disco":2048,"spazio_storico":3072,"spazio_conservazione":512,"conservazione":true,"storico":true,"sms":false,"autorinnovo":false,"phishing_protection":false,"password_protection":false,"invio_massivo":false,"invio_massivo_pec":0,"id":"6045fdee3a716847a978a471"},"operazioni_eseguite":["rinnovo","modifica"],"success":true,"message":"","error":null}}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"success":false,"message":"Wrong id","error":645,"data":null}}}},"404":{"description":"Not Found","content":{"application/json":{"example":{"success":false,"message":"no pec found","error":646,"data":null}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"examples":{"rinnovo_anni_invalid":{"value":{"success":false,"message":"rinnovo_anni must be between 1 and 3","error":705,"data":null}},"upgrade_not_valid":{"value":{"success":false,"message":"upgrade_casella not valid: STANDARD|BRONZE|SILVER|GOLD","error":706,"data":null}},"already_same_type":{"value":{"success":false,"message":"pec is already SILVER","error":707,"data":null}},"downgrade_not_allowed":{"value":{"success":false,"message":"downgrade of tipo_casella is not allowed","error":708,"data":null}},"spazio_disco_invalid":{"value":{"success":false,"message":"spazio_disco must be a positive multiple of 1024 MB","error":709,"data":null}},"spazio_storico_invalid":{"value":{"success":false,"message":"spazio_storico must be a positive multiple of 1024 MB","error":710,"data":null}},"invio_massivo_invalid":{"value":{"success":false,"message":"invio_massivo_pec must be a positive multiple of 50","error":714,"data":null}},"spazio_conservazione_invalid":{"value":{"success":false,"message":"spazio_conservazione must be a positive multiple of 512 MB","error":715,"data":null}}}}}},"428":{"description":"Precondition Required","content":{"application/json":{"examples":{"locked":{"value":{"success":false,"message":"pec locked, retry later","error":700,"data":null},"summary":"Attualmente non raggiungibile: \"lock\" non è una proprietà dichiarata su PecBase, quindi non viene mai aggiornata dal database e risulta sempre falsa in fase di esecuzione."},"no_operations":{"value":{"success":false,"message":"no operations specified","error":701,"data":null}},"wrong_stato_attivazione":{"value":{"success":false,"message":"ModuloAttivazione requires stato registrata/documenti_errati","error":702,"data":null}},"wrong_stato_evasa":{"value":{"success":false,"message":"operations require stato evasa","error":704,"data":null}},"upgrade_casella_not_supported_namirial":{"value":{"success":false,"message":"this service cannot be activated on these boxes: DOMICILIODIGITALE|PECMASSIVA","error":236,"data":null},"summary":"Solo caselle Namirial — l’operazione upgrade_casella fallisce sempre su Namirial, poiché non esistono livelli a cui effettuare l’aggiornamento (DOMICILIODIGITALE/PECMASSIVA non fanno parte della scala STANDARD/BRONZE/SILVER/GOLD)."}}}}}}}},"/pec/{id}/attivazione":{"patch":{"tags":["Pec"],"summary":"Attivazione dell'indirizzo e-mail certificato","description":"Questo metodo ti consente, una volta registrata la tua casella di posta elettronica certificata, di attivarla caricando la documentazione necessaria. La documentazione richiesta comprende un documento di identità valido e il modulo di attivazione compilato e firmato, scaricabile tramite il metodo GET/pec/{id}/modulo_attivazione. Per le caselle di tipo DOMICILIODIGITALE e PECMASSIVA è necessario creare un unico documento che comprenda il modulo di attivazione firmato e il documento di identità.","parameters":[{"name":"id","in":"path","description":"Pec id","required":true,"schema":{"type":"string","example":"6045fdee3a716847a978a471"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["documenti"],"properties":{"documenti":{"oneOf":[{"type":"string","description":"base64_encode(contenuto del file); sono ammessi solo file PDF"},{"type":"array","items":{"type":"string","description":"base64_encode(contenuto del file); sono ammessi solo file PDF"}}]}}},"example":{"documenti":["JVBERi0xLjUKJeLjz9MKNyAwIG9iago8PAovVHlwZSAvRm9udERlc2NyaXB0b3IKL0ZvbnROYW1lIC9UaW1lcyMyME5ldyMyMFJvbWFuCi9GbGFncyAzMgovSXRhbGljQW5nbGUgMAovQXNjZW50IDg5MQovRGVzY2VudCAtMjE2Ci9DYXBIZWlnaHQgNjkzCi9BdmdXaWR0aCA0MDEKL01heFdpZHRoIDI2MTQKL0ZvbnRXZWlnaHQgNDAwCi9YSGVpZ2h0IDI1MAovTGVhZGluZyA0MgovU3RlbVYgNDAKL0ZvbnRCQm94IFstNTY4IC0yMTYgMjA0NiA2OTNdCj4+CmVuZG9iago4IDAgb2JqClsyNTAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAyNTAgMCA1MDAgMCA1MDAgMCAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgNDQ0IDAgNDQ0IDAgMCAwIDAgMCAyNzggMCAwIDAgMCA1MDAgNTAwIDUwMCAwIDMzMyAzODkgMjc4IDAgNTAwXQplbmRvYmoKNiAwIG9iago8PAovVHlwZSAvRm9udAovU3VidHlwZSAvVHJ1ZVR5cGUKL05hbWUgL0YxCi9CYXNlRm9udCAvVGltZXMjMjBOZXcjMjBSb21hbgovRW5jb2RpbmcgL1dpbkFuc2lFbmNvZGluZwovRm9udERlc2NyaXB0b3IgNyAwIFIKL0ZpcnN0Q2hhciAzMgovTGFzdENoYXIgMTE4Ci9XaWR0aHMgOCAwIFIKPj4KZW5kb2JqCjkgMCBvYmoKPDwKL1R5cGUgL0V4dEdTdGF0ZQovQk0gL05vcm1hbAovY2EgMQo+PgplbmRvYmoKMTAgMCBvYmoKPDwKL1R5cGUgL0V4dEdTdGF0ZQovQk0gL05vcm1hbAovQ0EgMQo+PgplbmRvYmoKMTEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZ","JVBERi0xLjUKJeLjz9MKNyAwIG9iago8PAovVHlwZSAvRm9udERlc2NyaXB0b3IKL0ZvbnROYW1lIC9UaW1lcyMyME5ldyMyMFJvbWFuCi9GbGFncyAzMgovSXRhbGljQW5nbGUgMAovQXNjZW50IDg5MQovRGVzY2VudCAtMjE2Ci9DYXBIZWlnaHQgNjkzCi9BdmdXaWR0aCA0MDEKL01heFdpZHRoIDI2MTQKL0ZvbnRXZWlnaHQgNDAwCi9YSGVpZ2h0IDI1MAovTGVhZGluZyA0MgovU3RlbVYgNDAKL0ZvbnRCQm94IFstNTY4IC0yMTYgMjA0NiA2OTNdCj4+CmVuZG9iago4IDAgb2JqClsyNTAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAyNTAgMCA1MDAgMCA1MDAgMCAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAw"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Casella"},"success":{"type":"boolean","description":"Esito dell'operazione (vero/falso)."},"message":{"type":"string","description":"messaggio di errore"},"error":{"type":"integer","description":"codice di errore"}}},"example":{"data":{"casella_pec":"yourpec@testcert.legalmail.it","tipo_casella":"BRONZE","tipo_cliente":"PV","sottotipo_cliente":"","sottotipo_cliente_altro":"","nome_richiedente":"mario","cognome_richiedente":"rossi","email":"mail@domain.com","telefono":"0548798569","codice_fiscale_richiedente":"RSSXXXXXXXX56E","data_nascita_richiedente":"11/04/1982","sesso_richiedente":"M","nazione_nascita_richiedente":"IT","provincia_nascita_richiedente":"RM","denominazione_titolare":"","cf_piva_titolare":"","indirizzo_titolare":"via verdi 20","comune_titolare":"roma","cap_titolare":"00042","nazione_titolare":"IT","provincia_titolare":"rm","callback":{"url":"https://your_domain.it/your_callback.php"},"dominio":"testcert.legalmail.it","owner":"mail@domain.com","timestamp":{"registrazione":1615199724,"ultima_modifica":1615200175},"cellulare":"","comune_nascita_richiedente":"","cod_attivazione":"10174594","uid":"MA178634","conservazione":false,"data_scadenza":"","descrizione":"yourpec@testcert.legalmail.it","sms":false,"spazio_conservazione":0,"spazio_disco":0,"spazio_storico":0,"stato":"in_evasione","storico":false,"documenti_attivazione":["6045fdee3a716847a978a471_0_attivazione.pdf","6045fdee3a716847a978a471_1_attivazione.pdf"],"id":"6045fdee3a716847a978a471","autorinnovo":false},"success":true,"message":"","error":null}}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"success":false,"message":"Wrong id","error":645,"data":null}}}},"404":{"description":"Not Found","content":{"application/json":{"example":{"success":false,"message":"no pec found","error":646,"data":null}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"example":{"success":false,"message":"wrong file format, pdf required","error":528,"data":null}}}},"428":{"description":"Precondition Required","content":{"application/json":{"examples":{"wrong_stato_infocert":{"value":{"success":false,"message":"you can activate the pec only when it is in the 'registrata|documenti_errati' state","error":539,"data":null}},"wrong_stato_namirial":{"value":{"success":false,"message":"you can activate the pec only when it is in the 'registrata|documenti_errati' state","error":602,"data":null}},"pdf_merge_failed_namirial":{"value":{"success":false,"message":"Errore nella generazione del documento di attivazione","error":603,"data":null}}}}}}}}},"/pec/{id}/modifica":{"patch":{"tags":["Pec"],"summary":"Modifica delle impostazioni della casella di posta","description":"Modifica delle impostazioni di una casella PEC attiva. I campi relativi allo spazio (spazio_disco, spazio_storico, spazio_conservazione) accettano un numero intero (valore assoluto) o una stringa preceduta dal segno '+' per un aumento incrementale (ad es. '+1024'). Per lo spazio sono consentiti solo aumenti. I campi booleani attivano servizi opzionali (phishing_protection, password_protection) — solo per InfoCert, nessun effetto sulle caselle Namirial. invio_massivo_pec imposta la quota dell'add-on per l'invio in massa (multiplo di 50) — anch'essa solo per InfoCert. È necessario specificare almeno un campo.","parameters":[{"name":"id","in":"path","description":"Pec id","required":true,"schema":{"type":"string","example":"6045fdee3a716847a978a471"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"spazio_disco":{"oneOf":[{"type":"string","example":"+1024","multipleOf":1024},{"type":"integer","example":1024,"multipleOf":1024}],"description":"Se si antepone il simbolo +, si aggiunge spazio a quanto già presente. Se si specifica solo un numero, lo spazio viene impostato su quel valore."},"spazio_storico":{"oneOf":[{"type":"string","example":"+1024","multipleOf":1024},{"type":"integer","example":1024,"multipleOf":1024}],"description":"Se si antepone il simbolo +, si aggiunge spazio a quanto già presente. Se si passa solo un numero, si imposta lo spazio con quel valore."},"spazio_conservazione":{"oneOf":[{"type":"string","example":"+512","multipleOf":512},{"type":"integer","example":512,"multipleOf":512}],"description":"Se si inserisce il simbolo + all'inizio, si aggiunge spazio a quanto già presente. Se si inserisce solo un numero, lo spazio viene impostato su quel valore. Richiede che il servizio \"conservazione\" sia attivo."},"invio_massivo_pec":{"type":"integer","multipleOf":50,"minimum":50,"example":100,"description":"Solo per InfoCert. Quota aggiuntiva per l'invio in massa. Deve essere un multiplo positivo di 50 (ad es. 50, 100, 150). Non supportato sui server Namirial."},"phishing_protection":{"type":"boolean","example":true,"description":"Solo InfoCert. Attiva il componente aggiuntivo di protezione dal phishing. Non può essere impostato su \"true\" se è già attivo (ERROR 516). Non supportato sui dispositivi Namirial."},"password_protection":{"type":"boolean","example":true,"description":"Solo InfoCert. Attiva il componente aggiuntivo di protezione con password. Non può essere impostato su \"true\" se già attivo (ERROR 517). Non supportato sui server Namirial."}}},"example":{"spazio_disco":"+1024","invio_massivo_pec":100,"phishing_protection":true}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Casella"},"success":{"type":"boolean","description":"Esito positivo dell'operazione (vero/falso)."},"message":{"type":"string","description":"messaggio di errore"},"error":{"type":"integer","description":"codice di errore"}}},"example":{"data":{"casella_pec":"yourpec@testcert.legalmail.it","tipo_casella":"GOLD","tipo_cliente":"PV","sottotipo_cliente":"","sottotipo_cliente_altro":"","nome_richiedente":"mario","cognome_richiedente":"rossi","email":"mail@domain.com","telefono":"0548798569","codice_fiscale_richiedente":"RSSXXXXXXXX56E","data_nascita_richiedente":"11/04/1982","sesso_richiedente":"M","nazione_nascita_richiedente":"IT","provincia_nascita_richiedente":"RM","denominazione_titolare":"","cf_piva_titolare":"","indirizzo_titolare":"via verdi 20","comune_titolare":"roma","cap_titolare":"00042","nazione_titolare":"IT","provincia_titolare":"rm","callback":{"url":"https://your_domain.it/your_callback.php"},"dominio":"testcert.legalmail.it","owner":"mail@domain.com","timestamp":{"registrazione":1615199724,"evasione":1615199724,"scadenza":1646391493,"ultima_modifica":1615200175},"cellulare":"","comune_nascita_richiedente":"","cod_attivazione":"10174594","uid":"MA178634","conservazione":true,"data_attivazione":"20/04/2021","data_scadenza":"20/04/2022","descrizione":"yourpec@testcert.legalmail.it","sms":true,"spazio_conservazione":1536,"spazio_disco":3072,"spazio_storico":14336,"stato":"evasa","storico":true,"documenti_attivazione":["6045fdee3a716847a978a471_0_attivazione.pdf","6045fdee3a716847a978a471_1_attivazione.pdf"],"documenti_conservazione":["6045fdee3a716847a978a471_0_conservazione.pdf"],"id":"6045fdee3a716847a978a471","autorinnovo":false},"success":true,"message":"","error":null}}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"success":false,"message":"Wrong id","error":645,"data":null}}}},"402":{"description":"Pagamento richiesto","content":{"application/json":{"example":{"success":false,"message":"Insufficient Credit in Wallet: 182.03","error":290,"data":null}}}},"404":{"description":"Not Found","content":{"application/json":{"example":{"success":false,"message":"no pec found","error":646,"data":null}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"examples":{"spazio_disco_same":{"summary":"spazio_disco: il valore è uguale al valore attuale","value":{"success":false,"message":"you already have this space value","error":284,"data":null}},"spazio_disco_lower":{"summary":"spazio_disco: valore inferiore a quello attuale","value":{"success":false,"message":"you cannot decrease your space","error":285,"data":null}},"spazio_storico_same":{"summary":"spazio_storico: il valore è uguale al valore attuale","value":{"success":false,"message":"you already have this space value","error":286,"data":null}},"spazio_storico_lower":{"summary":"spazio_storico: valore inferiore a quello attuale","value":{"success":false,"message":"you cannot decrease your space","error":287,"data":null}},"spazio_conservazione_same":{"summary":"spazio_conservazione: il valore è uguale al valore attuale","value":{"success":false,"message":"you already have this space value","error":288,"data":null}},"spazio_conservazione_lower":{"summary":"spazio_conservazione: valore inferiore a quello attuale","value":{"success":false,"message":"you cannot decrease your space","error":289,"data":null}},"space_negative":{"summary":"Qualsiasi campo spazio: valore negativo passato","value":{"success":false,"message":"you cannot decrease your space","error":523,"data":null}},"space_wrong_multiple":{"summary":"Qualsiasi campo spazio: non è un multiplo di 512 (conservazione) o di 1024 (altri)","value":{"success":false,"message":"the system only takes into account multiples of 1024","error":525,"data":null}},"invio_massivo_pec_invalid":{"summary":"invio_massivo_pec non è un multiplo di 50","value":{"success":false,"message":"invio_massivo_pec must be a multiple of 50 (e.g. 50, 100, 150)","error":515,"data":null}},"phishing_already_active":{"summary":"Protezione contro il phishing già attiva","value":{"success":false,"message":"phishing protection is already active","error":516,"data":null}},"password_already_active":{"summary":"Protezione con password già attiva","value":{"success":false,"message":"password protection is already active","error":517,"data":null}}}}}},"428":{"description":"Precondition Required","content":{"application/json":{"examples":{"not_processed":{"summary":"PEC non ancora elaborato","value":{"success":false,"message":"you can modify your certified mail only if it has been processed","error":513,"data":null}},"conservazione_not_active":{"summary":"Servizio di conservazione non attivo","value":{"success":false,"message":"you must first activate the 'conservazione' service","error":514,"data":null}},"no_values":{"summary":"Non sono stati forniti campi di modifica","value":{"success":false,"message":"you did not pass any values","error":518,"data":null}}}}}}}}},"/pec/{id}/conservazione":{"patch":{"tags":["Pec"],"summary":"Attivazione delle misure di conservazione ai sensi di legge","description":"Questo metodo consente di attivare il servizio di archiviazione standard nella propria posta elettronica certificata. È supportato per tutti i tipi di casella di posta, inclusi DOMICILIODIGITALE e PECMASSIVA (Namirial). Questa operazione si limita a preparare la richiesta (spazio + documenti): l’effettiva attivazione da parte del provider viene effettuata in un secondo momento da un operatore, non tramite questa API. InfoCert richiede un solo documento (“documenti” come stringa semplice o array con un solo elemento); Namirial ne richiede esattamente due, da passare in ordine (1° = contratto di conservazione, 2° = informativa sulla privacy) — si veda l’esempio di richiesta “namirial”.","parameters":[{"name":"id","in":"path","description":"Pec id","required":true,"schema":{"type":"string","example":"6045fdee3a716847a978a471"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"spazio_conservazione":{"oneOf":[{"type":"string","example":"1024","multipleOf":512},{"type":"integer","example":1024,"multipleOf":512}],"description":"Se questo parametro non viene specificato, il valore predefinito è 512 (InfoCert) o 1024 (Namirial)"},"documenti":{"oneOf":[{"type":"string","description":"base64_encode(contenuto del file); sono ammessi solo file PDF. Solo per InfoCert — Namirial richiede 2 documenti, utilizzare il formato array."},{"type":"array","items":{"type":"string","description":"base64_encode(contenuto del file); sono ammessi solo file PDF"},"description":"InfoCert: è sufficiente un solo elemento. Namirial: deve contenere esattamente 2 elementi, nell'ordine: [0] = contratto di conservazione, [1] = informativa sulla privacy."}]}},"required":["documenti"]},"examples":{"infocert":{"summary":"Esempio di InfoCert","value":{"spazio_conservazione":512,"documenti":"JVBERi0xLjUKJeLjz9MKNyAwIG9iago8PAovVHlwZSAvRm9udERlc2NyaXB0b3IKL0ZvbnROYW1lIC9UaW1lcyMyME5ldyMyMFJvbWFuCi9GbGFncyAzMgovSXRhbGljQW5nbGUgMAovQXNjZW50IDg5MQovRGVzY2VudCAtMjE2Ci9DYXBIZWlnaHQgNjkzCi9BdmdXaWR0aCA0MDEKL01heFdpZHRoIDI2MTQKL0ZvbnRXZWlnaHQgNDAwCi9YSGVpZ2h0IDI1MAovTGVhZGluZyA0MgovU3RlbVYgNDAKL0ZvbnRCQm94IFstNTY4IC0yMTYgMjA0NiA2OTNdCj4+CmVuZG9iago4IDAgb2JqClsyNTAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAyNTAgMCA1MDAgMCA1MDAgMCAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgNDQ0IDAgNDQ0IDAgMCAwIDAgMCAyNzggMCAwIDAgMCA1MDAgNTAwIDUwMCAwIDMzMyAzODkgMjc4IDAgNTAwXQplbmRvYmoKNiAwIG9iago8PAovVHlwZSAvRm9udAovU3VidHlwZSAvVHJ1ZVR5cGUKL05hbWUgL0YxCi9CYXNlRm9udCAvVGltZXMjMjBOZXcjMjBSb21hbgovRW5jb2RpbmcgL1dpbkFuc2lFbmNvZGluZwovRm9udERlc2NyaXB0b3IgNyAwIFIKL0ZpcnN0Q2hhciAzMgovTGFzdENoYXIgMTE4Ci9XaWR0aHMgOCAwIFIKPj4KZW5kb2JqCjkgMCBvYmoKPDwKL1R5cGUgL0V4dEdTdGF0ZQovQk0gL05vcm1hbAovY2EgMQo+PgplbmRvYmoKMTAgMCBvYmoKPDwKL1R5cGUgL0V4dEdTdGF0ZQovQk0gL05vcm1hbAovQ0EgMQo+PgplbmRvYmoKMTEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZ"}},"namirial":{"summary":"Esempio di Namirial","value":{"spazio_conservazione":1024,"documenti":["JVBERi0xLjQKJ...(contratto conservazione)","JVBERi0xLjQKJ...(informativa privacy)"]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Casella"},"success":{"type":"boolean","description":"Esito dell'operazione (vero/falso)."},"message":{"type":"string","description":"messaggio di errore"},"error":{"type":"integer","description":"codice di errore"}}},"example":{"data":{"casella_pec":"yourpec@testcert.legalmail.it","tipo_casella":"GOLD","tipo_cliente":"PV","sottotipo_cliente":"","sottotipo_cliente_altro":"","nome_richiedente":"mario","cognome_richiedente":"rossi","email":"mail@domain.com","telefono":"0548798569","codice_fiscale_richiedente":"RSSXXXXXXXX56E","data_nascita_richiedente":"11/04/1982","sesso_richiedente":"M","nazione_nascita_richiedente":"IT","provincia_nascita_richiedente":"RM","denominazione_titolare":"","cf_piva_titolare":"","indirizzo_titolare":"via verdi 20","comune_titolare":"roma","cap_titolare":"00042","nazione_titolare":"IT","provincia_titolare":"rm","callback":{"url":"https://your_domain.it/your_callback.php"},"dominio":"testcert.legalmail.it","owner":"mail@domain.com","timestamp":{"registrazione":1615199724,"evasione":1615199724,"scadenza":1646391493,"ultima_modifica":1615200175},"cellulare":"","comune_nascita_richiedente":"","cod_attivazione":"10174594","uid":"MA178634","conservazione":true,"data_attivazione":"20/04/2021","data_scadenza":"20/04/2022","descrizione":"yourpec@testcert.legalmail.it","sms":true,"spazio_conservazione":1024,"spazio_disco":2048,"spazio_storico":13312,"stato":"evasa","storico":true,"documenti_attivazione":["6045fdee3a716847a978a471_0_attivazione.pdf","6045fdee3a716847a978a471_1_attivazione.pdf"],"documenti_conservazione":["6045fdee3a716847a978a471_0_conservazione.pdf"],"id":"6045fdee3a716847a978a471","autorinnovo":false},"success":true,"message":"","error":null}}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"success":false,"message":"Wrong id","error":645,"data":null}}}},"402":{"description":"Pagamento richiesto","content":{"application/json":{"example":{"success":false,"message":"Insufficient Credit in Wallet: 182.03","error":297,"data":null}}}},"404":{"description":"Not Found","content":{"application/json":{"example":{"success":false,"message":"no pec found","error":646,"data":null}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"examples":{"already_active_infocert":{"value":{"success":false,"message":"conservazione service is already active","error":541,"data":null}},"already_active_namirial":{"value":{"success":false,"message":"conservazione service is already active","error":645,"data":null},"summary":"Solo caselle Namirial. Nota: il codice di errore 645 è sovraccarico in questa API — sullo stesso endpoint indica anche \"ID errato\" con codice HTTP 400 (vedi la risposta 400 sopra); l'uso del codice HTTP 406 con questo messaggio è l'unico modo per distinguere i due casi."}}}}},"428":{"description":"Precondition Required","content":{"application/json":{"examples":{"documenti_required":{"value":{"success":false,"message":"documenti required","error":526,"data":null}},"not_processed_infocert":{"value":{"success":false,"message":"you can activate this service only if the pec has been processed","error":540,"data":null}},"not_processed_namirial":{"value":{"success":false,"message":"you can activate this service only if the pec has been processed","error":644,"data":null}}}}}}}}},"/pec/{id}/trasformazione":{"patch":{"tags":["Pec"],"summary":"Modifica il tipo di casella","description":"This method allows you to modify the type of certified email. Only updates are allowed: for example, from a STANDARD mailbox you can switch to a SILVER or GOLD mailbox. The operation is not allowed for these two types of mailboxes: DOMICILIODIGITALE, PECMASSIVA.","parameters":[{"name":"id","in":"path","description":"Pec id","required":true,"schema":{"type":"string","example":"6045fdee3a716847a978a471"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tipo_casella":{"type":"string","description":"type of mailbox","enum":["STANDARD","BRONZE","SILVER","GOLD"]}}},"example":{"tipo_casella":"GOLD"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Casella"},"success":{"type":"boolean","description":"Esito positivo dell'operazione (vero/falso)."},"message":{"type":"string","description":"messaggio di errore"},"error":{"type":"integer","description":"codice di errore"}}},"example":{"data":{"casella_pec":"yourpec@testcert.legalmail.it","tipo_casella":"GOLD","tipo_cliente":"PV","sottotipo_cliente":"","sottotipo_cliente_altro":"","nome_richiedente":"mario","cognome_richiedente":"rossi","email":"mail@domain.com","telefono":"0548798569","codice_fiscale_richiedente":"RSSXXXXXXXX56E","data_nascita_richiedente":"11/04/1982","sesso_richiedente":"M","nazione_nascita_richiedente":"IT","provincia_nascita_richiedente":"RM","denominazione_titolare":"","cf_piva_titolare":"","indirizzo_titolare":"via verdi 20","comune_titolare":"roma","cap_titolare":"00042","nazione_titolare":"IT","provincia_titolare":"rm","callback":{"url":"https://your_domain.it/your_callback.php"},"dominio":"testcert.legalmail.it","owner":"mail@domain.com","timestamp":{"registrazione":1615199724,"evasione":1615199724,"scadenza":1646391493,"ultima_modifica":1615200175},"cellulare":"","comune_nascita_richiedente":"","cod_attivazione":"10174594","uid":"MA178634","conservazione":false,"data_attivazione":"20/04/2021","data_scadenza":"20/04/2022","descrizione":"yourpec@testcert.legalmail.it","sms":true,"spazio_conservazione":0,"spazio_disco":2048,"spazio_storico":13312,"stato":"evasa","storico":true,"documenti_attivazione":["6045fdee3a716847a978a471_0_attivazione.pdf","6045fdee3a716847a978a471_1_attivazione.pdf"],"id":"6045fdee3a716847a978a471","autorinnovo":false},"success":true,"message":"","error":null}}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"success":false,"message":"Wrong id","error":645,"data":null}}}},"402":{"description":"Pagamento richiesto","content":{"application/json":{"example":{"success":false,"message":"Insufficient Credit in Wallet: 182.03","error":279,"data":null}}}},"404":{"description":"Not Found","content":{"application/json":{"example":{"success":false,"message":"no pec found","error":646,"data":null}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"examples":{"downgrade_not_allowed":{"value":{"success":false,"message":"a downgrade of the 'tipo_casella' is not allowed","error":522,"data":null}},"tipo_casella_not_valid":{"value":{"success":false,"message":"tipo_casella not valid: STANDARD|BRONZE|SILVER|GOLD","error":520,"data":null}}}}}},"428":{"description":"Precondition Required","content":{"application/json":{"examples":{"wrong_stato_infocert":{"value":{"success":false,"message":"you can trasform your certified mail only if it has been processed","error":519,"data":null}},"not_supported_namirial":{"value":{"success":false,"message":"this service cannot be activated on these boxes: DOMICILIODIGITALE|PECMASSIVA","error":609,"data":null}}}}}}}}},"/pec/{id}/rinnovo":{"get":{"tags":["Pec"],"summary":"Rinnovo dell'indirizzo e-mail certificato","description":"Questo metodo consente di rinnovare per un anno o di riattivare l'indirizzo e-mail certificato identificato dall'ID","parameters":[{"name":"id","in":"path","description":"Pec id","required":true,"schema":{"type":"string","example":"6040e4613a716838dc4eee0e"}},{"name":"anni","in":"query","description":"Numero di anni per i quali si desidera rinnovare la casella PEC (1-3). Se non specificato, il valore predefinito è 1. I valori superiori a 3 vengono automaticamente limitati a 3; i valori non numerici o inferiori a 1 generano l'errore 649.","required":false,"schema":{"type":"integer","minimum":1,"maximum":3,"example":2}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Casella"},"success":{"type":"boolean","description":"Esito dell'operazione (vero/falso)."},"message":{"type":"string","description":"messaggio di errore"},"error":{"type":"integer","description":"codice di errore"}}},"example":{"data":{"casella_pec":"yourpec@testcert.legalmail.it","tipo_casella":"BRONZE","tipo_cliente":"PV","sottotipo_cliente":"","sottotipo_cliente_altro":"","nome_richiedente":"mario","cognome_richiedente":"rossi","email":"mail@domain.com","telefono":"0548798569","codice_fiscale_richiedente":"RSSXXXXXXXX56E","data_nascita_richiedente":"11/04/1982","sesso_richiedente":"M","nazione_nascita_richiedente":"IT","provincia_nascita_richiedente":"RM","denominazione_titolare":"","cf_piva_titolare":"","indirizzo_titolare":"via verdi 20","comune_titolare":"roma","cap_titolare":"00042","nazione_titolare":"IT","provincia_titolare":"rm","callback":{"url":"https://your_domain.it/your_callback.php"},"dominio":"testcert.legalmail.it","owner":"mail@domain.com","timestamp":{"registrazione":1614865504,"ultima_modifica":1614868403,"evasione":1614868312,"scadenza":1646391493},"cellulare":"","comune_nascita_richiedente":"","cod_attivazione":"10173956","uid":"MA177987","conservazione":true,"data_scadenza":"04/03/2022","descrizione":"yourpec@testcert.legalmail.it","sms":true,"spazio_conservazione":512,"spazio_disco":3072,"spazio_storico":3072,"stato":"evasa","storico":true,"documenti_attivazione":["6040e4613a716838dc4eee0e_0_attivazione.pdf","6040e4613a716838dc4eee0e_1_attivazione.pdf"],"data_attivazione":"04/03/2021","documenti_conservazione":["6040e4613a716838dc4eee0e_0_conservazione.pdf","6040e4613a716838dc4eee0e_1_conservazione.pdf"],"multiutenza":[{"nome":"luca","cognome":"bianchi","descrizione":"prima utenza","email_gestione_password":"mail@domain.com","id_utenza":"6040e4613a716838dc4eee0e_0","timestamp":{"attivazione":1614868138},"userid":"MA177993"}],"id":"6040e4613a716838dc4eee0e","autorinnovo":false},"success":true,"message":"","error":null}}}},"400":{"description":"Bad Request","content":{"application/json":{"examples":{"wrong_id":{"value":{"success":false,"message":"Wrong id","error":201,"data":null}},"invalid_anni":{"value":{"success":false,"message":"invalid anni parameter","error":649,"data":null}}}}}},"404":{"description":"Not Found","content":{"application/json":{"example":{"success":false,"message":"no pec found","error":202,"data":null}}}},"428":{"description":"Precondition Required","content":{"application/json":{"examples":{"wrong_stato":{"value":{"success":false,"message":"you can renew only evaded or revoked pec","error":203,"data":null}},"revocata_too_long_infocert":{"value":{"success":false,"message":"casella revocata da piu di 6 mesi","error":252,"data":null}},"revocata_too_long_namirial":{"value":{"success":false,"message":"casella revocata da piu di un mese","error":252,"data":null}}}}}}}}},"/pec/{id}/multiutenza":{"post":{"tags":["Pec"],"summary":"Aggiungi utente","description":"InfoCert: aggiunge un utente che può utilizzare una casella PEC esistente (operazione ripetibile, fino a 25 utenti). Namirial (DOMICILIODIGITALE/PECMASSIVA): non aggiunge alcun utente — questa chiamata attiva una sola volta il servizio di attivazione/disattivazione della modalità multiutente. Per Namirial il corpo della richiesta non viene letto affatto; è sufficiente un '{}' vuoto; richiamando la funzione si ottiene l'ERROR 596 «multiutenza disponibile solo per questa PEC».","parameters":[{"name":"id","in":"path","description":"Pec id","required":true,"schema":{"type":"string","example":"6040e4613a716838dc4eee0e"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BodyPostMultiutenza"},"examples":{"infocert":{"summary":"Esempio di InfoCert","value":{"nome":"luca","cognome":"bianchi","descrizione":"prima utenza","email_gestione_password":"mail@domain.com"}},"namirial":{"summary":"Esempio di Namirial","value":{}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Casella"},"success":{"type":"boolean","description":"Esito positivo dell'operazione (vero/falso)."},"message":{"type":"string","description":"messaggio di errore"},"error":{"type":"integer","description":"codice di errore"}}},"example":{"data":{"casella_pec":"yourpec@testcert.legalmail.it","tipo_casella":"BRONZE","tipo_cliente":"PV","sottotipo_cliente":"","sottotipo_cliente_altro":"","nome_richiedente":"mario","cognome_richiedente":"rossi","email":"mail@domain.com","telefono":"0548798569","codice_fiscale_richiedente":"RSSXXXXXXXX56E","data_nascita_richiedente":"11/04/1982","sesso_richiedente":"M","nazione_nascita_richiedente":"IT","provincia_nascita_richiedente":"RM","denominazione_titolare":"","cf_piva_titolare":"","indirizzo_titolare":"via verdi 20","comune_titolare":"roma","cap_titolare":"00042","nazione_titolare":"IT","provincia_titolare":"rm","callback":{"url":"https://your_domain.it/your_callback.php"},"dominio":"testcert.legalmail.it","owner":"mail@domain.com","timestamp":{"registrazione":1614865504,"ultima_modifica":1614868403,"evasione":1614868312,"scadenza":1646391493},"cellulare":"","comune_nascita_richiedente":"","cod_attivazione":"10173956","uid":"MA177987","conservazione":true,"data_scadenza":"04/03/2022","descrizione":"yourpec@testcert.legalmail.it","sms":true,"spazio_conservazione":512,"spazio_disco":3072,"spazio_storico":3072,"stato":"evasa","storico":true,"documenti_attivazione":["6040e4613a716838dc4eee0e_0_attivazione.pdf","6040e4613a716838dc4eee0e_1_attivazione.pdf"],"data_attivazione":"04/03/2021","documenti_conservazione":["6040e4613a716838dc4eee0e_0_conservazione.pdf","6040e4613a716838dc4eee0e_1_conservazione.pdf"],"multiutenza":[{"nome":"luca","cognome":"bianchi","descrizione":"prima utenza","email_gestione_password":"mail@domain.com","id_utenza":"6040e4613a716838dc4eee0e_0","timestamp":{"attivazione":1614868138},"userid":"MA177993"}],"id":"6040e4613a716838dc4eee0e","autorinnovo":false},"success":true,"message":"","error":null}}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"success":false,"message":"Wrong id","error":645,"data":null}}}},"402":{"description":"Pagamento richiesto","content":{"application/json":{"example":{"success":false,"message":"Insufficient Credit in Wallet: 182.03","error":220,"data":null}}}},"404":{"description":"Not Found","content":{"application/json":{"example":{"success":false,"message":"no pec found","error":646,"data":null}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"examples":{"max_users_infocert":{"value":{"success":false,"message":"maximum number of users reached: 25","error":535,"data":null}},"already_active_namirial":{"value":{"success":false,"message":"multiutenza just available for this pec","error":596,"data":null}},"email_gestione_password_not_valid":{"value":{"success":false,"message":"email_gestione_password not valid","error":548,"data":null}}}}}},"428":{"description":"Precondition Required","content":{"application/json":{"examples":{"wrong_stato_infocert":{"value":{"success":false,"message":"you can activate this service only if the pec has been processed","error":543,"data":null}},"wrong_stato_namirial":{"value":{"success":false,"message":"you can activate this service only if the pec has been processed","error":604,"data":null}},"nome_required":{"value":{"success":false,"message":"nome required","error":544,"data":null}},"cognome_required":{"value":{"success":false,"message":"cognome required","error":545,"data":null}},"descrizione_required":{"value":{"success":false,"message":"descrizione required","error":546,"data":null},"summary":"Solo caselle InfoCert — il campo “descrizione” è obbligatorio come previsto dal codice, anche se non è elencato in BodyPostMultiutenza.required. Viene ignorato per le caselle Namirial (DOMICILIODIGITALE/PECMASSIVA), che non verificano affatto questi campi."},"email_gestione_password_required":{"value":{"success":false,"message":"email_gestione_password required","error":547,"data":null}}}}}}}},"get":{"tags":["Pec"],"summary":"Elencare (o recuperare) un utente slave multiutente","description":"Restituisce gli utenti secondari del servizio multiutente di una casella di posta InfoCert. Non applicabile alle caselle Namirial (DOMICILIODIGITALE/PECMASSIVA), il cui campo \"multiutente\" è un valore booleano e non un array — vedi ERROR 208.","parameters":[{"name":"id","in":"path","description":"Pec id","required":true,"schema":{"type":"string","example":"6040e4613a716838dc4eee0e"}},{"name":"id_subset","in":"query","description":"Se specificato, restituisce solo l'utente slave presente a quell'indice anziché l'elenco completo. Formato: '<QUALSIASI_PREFISSO>_<INDICE>' (viene utilizzata solo la parte dopo l'ultimo trattino basso; ad esempio, il valore 'id_utenza' della casella di posta stessa funziona direttamente).","required":false,"schema":{"type":"string","example":"6040e4613a716838dc4eee0e_0"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/Utenza"}},{"$ref":"#/components/schemas/Utenza"}]},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer","nullable":true}}},"example":{"data":[{"nome":"luca","cognome":"bianchi","descrizione":"prima utenza","email_gestione_password":"mail@domain.com","id_utenza":"6040e4613a716838dc4eee0e_0","timestamp":{"attivazione":1614868138},"userid":"MA177993"}],"success":true,"message":"","error":null}}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"success":false,"message":"Wrong id","error":645,"data":null}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"no_pec_found":{"value":{"success":false,"message":"no pec found","error":646,"data":null}},"multiutenza_not_active":{"value":{"success":false,"message":"multiuser not yet activated on this box","error":208,"data":null}}}}}}}}},"/comunica_pec":{"get":{"tags":["Comunica Pec"],"summary":"Elenco delle tue comunicazioni","description":"Questo metodo mostra tutte le comunicazioni via e-mail certificate che sono state startate al registro delle imprese","parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RichiesteComunicazionePec"}},"success":{"type":"boolean","description":"Esito dell'operazione (vero/falso)."},"message":{"type":"string","description":"messaggio di errore"},"error":{"type":"integer","description":"codice di errore"}}},"example":{"data":[{"id":"60ad149c3a7168084f1d2b68","casella_pec":"mypec@pec.com","stato":"documenti_caricati","timestamp":1622127248,"owner":"mail@domain.com"},{"id":"60ad0f2a3a716801f42a9773","casella_pec":"yourpec@pec.it","stato":"documenti_caricati","timestamp":1622126850,"owner":"mail@domain.com"}],"success":true,"message":"","error":null}}}},"404":{"description":"Not Found","content":{"application/json":{"example":{"success":false,"message":"no request linked to this account","error":332,"data":null}}}}}},"post":{"tags":["Comunica Pec"],"summary":"Inviare un’e-mail certificata","description":"Questo metodo consente di inviare un’e-mail certificata al registro delle imprese","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BodyPostComunicaPec"},"example":{"casella_pec":"mypec@pec.com","pec_amministratore":false,"cf":"RSSMRA80A01L117D","nome":"mario","cognome":"rossi","qualifica":"LEGALE_RAPPRESENTANTE","email":"mail@domain.com","cellulare":"34xxxxxx18","ragione_sociale":"azienda test","cf_piva":"12345678910","comune":"roma","provincia":"RM","callback":{"url":"https://your_domain.it/your_callback.php","custom":{"my_order_id":"123456"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RichiestaComunicazionePec"},"success":{"type":"boolean","description":"Esito dell'operazione (vero/falso)."},"message":{"type":"string","description":"messaggio di errore"},"error":{"type":"integer","description":"codice di errore"}}},"example":{"data":{"casella_pec":"mypec@pec.com","pec_amministratore":false,"cf":"RSSMRA80A01L117D","nome":"mario","cognome":"rossi","qualifica":"LEGALE_RAPPRESENTANTE","email":"mail@domain.com","cellulare":"34xxxxxx18","ragione_sociale":"azienda test","cf_piva":"12345678910","comune":"roma","provincia":"RM","callback":false,"stato":"codice_in_richiesta","codice_registro_imprese":"openapi","documenti_registro_imprese":[],"owner":"mail@domain.com","timestamp":1621955739,"id":"60ad149c3a7168084f1d2b68"},"success":true,"message":"","error":null}}}},"402":{"description":"Pagamento richiesto","content":{"application/json":{"example":{"success":false,"message":"Billing error message: Insufficient Credit in Wallet: 182.03","error":610,"data":null}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"examples":{"invalid_casella_pec":{"value":{"success":false,"message":"invalid casella_pec","error":336,"data":null}},"already_exists":{"value":{"success":false,"message":"a request already exists for this name: mypec@pec.com","error":337,"data":null}},"invalid_email":{"value":{"success":false,"message":"email not valid","error":340,"data":null}},"cellulare_not_numeric":{"value":{"success":false,"message":"cellulare must be numeric","error":342,"data":null}},"invalid_cf_piva":{"value":{"success":false,"message":"cf_piva not valid","error":345,"data":null}},"invalid_cf":{"value":{"success":false,"message":"cf not valid","error":400,"data":null}},"invalid_qualifica":{"value":{"success":false,"message":"qualifica not valid, choose one of these: [\"AMMINISTRATORE\",\"COMMISSARIO_GIUDIZIARIO\",\"CURATORE_FALLIMENTARE\",\"LEGALE_RAPPRESENTANTE\",\"LIQUIDATORE\",\"SOCIO\",\"TITOLARE\"]","error":403,"data":null}},"callback_url_malformed":{"value":{"success":false,"message":"malformed url","error":704,"data":null}},"callback_url_scheme":{"value":{"success":false,"message":"url must start with http:// or https://","error":706,"data":null}},"callback_custom_too_big":{"value":{"success":false,"message":"custom field exceeds 512 bytes","error":730,"data":null}},"callback_invalid_retry":{"value":{"success":false,"message":"invalid retry value","error":740,"data":null}},"callback_invalid_header":{"value":{"success":false,"message":"invalid header key or value","error":708,"data":null}},"callback_header_key_too_long":{"value":{"success":false,"message":"header key too long","error":709,"data":null}},"callback_header_value_not_string":{"value":{"success":false,"message":"header value must be a string","error":710,"data":null}},"callback_headers_too_long":{"value":{"success":false,"message":"headers too long","error":711,"data":null}}}}}},"428":{"description":"Precondition Required","content":{"application/json":{"examples":{"casella_pec_required":{"value":{"success":false,"message":"casella_pec required","error":335,"data":null}},"email_required":{"value":{"success":false,"message":"email required","error":339,"data":null}},"cellulare_required":{"value":{"success":false,"message":"cellulare required","error":341,"data":null}},"ragione_sociale_required":{"value":{"success":false,"message":"ragione_sociale required","error":343,"data":null}},"cf_piva_required":{"value":{"success":false,"message":"cf_piva required","error":344,"data":null}},"comune_required":{"value":{"success":false,"message":"comune required","error":346,"data":null}},"provincia_required":{"value":{"success":false,"message":"provincia required","error":347,"data":null}},"nome_required":{"value":{"success":false,"message":"nome required","error":348,"data":null}},"cognome_required":{"value":{"success":false,"message":"cognome required","error":349,"data":null}},"cf_required":{"value":{"success":false,"message":"cf required","error":350,"data":null}},"qualifica_required":{"value":{"success":false,"message":"qualifica required","error":351,"data":null}},"invalid_callback":{"value":{"success":false,"message":"Error: The 'callback' field has an invalid type (string or other), expected object|array. Value: <print_r output of the submitted value>","error":407,"data":null}}}}}}}}},"/comunica_pec/{id}":{"get":{"tags":["Comunica Pec"],"summary":"Richiesta specifica di comunicazione pec","description":"Questo metodo restituisce la richiesta specifica contrassegnata dall'ID","parameters":[{"name":"id","in":"path","description":"ID Comunica Pec","required":true,"schema":{"type":"string","example":"60ad149c3a7168084f1d2b68"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RichiestaComunicazionePec"},"success":{"type":"boolean","description":"Esito dell'operazione (vero/falso)."},"message":{"type":"string","description":"messaggio di errore"},"error":{"type":"integer","description":"codice di errore"}}},"example":{"data":{"casella_pec":"mypec@pec.com","pec_amministratore":false,"cf":"RSSMRA80A01L117D","nome":"mario","cognome":"rossi","qualifica":"LEGALE_RAPPRESENTANTE","email":"mail@domain.com","cellulare":"349xxxxx18","ragione_sociale":"azienda test","cf_piva":"12345678910","comune":"roma","provincia":"RM","callback":false,"stato":"documenti_caricati","codice_registro_imprese":"openapi","documenti_registro_imprese":["60ad149c3a7168084f1d2b68_0_registro_imprese.p7m"],"owner":"mail@domain.com","timestamp":1622127248,"id":"60ad149c3a7168084f1d2b68"},"success":true,"message":"","error":null}}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"success":false,"message":"Wrong id","error":333,"data":null}}}},"404":{"description":"Not Found","content":{"application/json":{"example":{"success":false,"message":"no request found","error":334,"data":null}}}}}},"patch":{"tags":["Comunica Pec"],"summary":"Carica i documenti","description":"Questo metodo consente di completare la richiesta di comunicazione del proprio PEC al Registro delle Imprese caricando la documentazione necessaria. La documentazione richiesta comprende il modulo compilato e firmato digitalmente (in formato PDF o p7m), che è possibile scaricare utilizzando il metodo GET/comunica_pec/{id}/procura_registro_imprese.","parameters":[{"name":"id","in":"path","description":"ID Comunica Pec","required":true,"schema":{"type":"string","example":"60dc8da86c8b04624536bbb2"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["documenti"],"properties":{"documenti":{"oneOf":[{"type":"string","description":"base64_encode(contenuto del file); sono accettati file PDF o p7m"},{"type":"array","items":{"type":"string","description":"base64_encode(contenuto del file); sono accettati file PDF o p7m"}}]}}},"example":{"documenti":"JVBERi0xLjUKJeLjz9MKNyAwIG9iago8PAovVHlwZSAvRm9udERlc2NyaXB0b3IKL0ZvbnROYW1lIC9UaW1lcyMyME5ldyMyMFJvbWFuCi9GbGFncyAzMgovSXRhbGljQW5nbGUgMAovQXNjZW50IDg5MQovRGVzY2VudCAtMjE2Ci9DYXBIZWlnaHQgNjkzCi9BdmdXaWR0aCA0MDEKL01heFdpZHRoIDI2MTQKL0ZvbnRXZWlnaHQgNDAwCi9YSGVpZ2h0IDI1MAovTGVhZGluZyA0MgovU3RlbVYgNDAKL0ZvbnRCQm94IFstNTY4IC0yMTYgMjA0NiA2OTNdCj4+CmVuZG9iago4IDAgb2JqClsyNTAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAyNTAgMCA1MDAgMCA1MDAgMCAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgNDQ0IDAgNDQ0IDAgMCAwIDAgMCAyNzggMCAwIDAgMCA1MDAgNTAwIDUwMCAwIDMzMyAzODkgMjc4IDAgNTAwXQplbmRvYmoKNiAwIG9iago8PAovVHlwZSAvRm9udAovU3VidHlwZSAvVHJ1ZVR5cGUKL05hbWUgL0YxCi9CYXNlRm9udCAvVGltZXMjMjBOZXcjMjBSb21hbgovRW5jb2RpbmcgL1dpbkFuc2lFbmNvZGluZwovRm9udERlc2NyaXB0b3IgNyAwIFIKL0ZpcnN0Q2hhciAzMgovTGFzdENoYXIgMTE4Ci9XaWR0aHMgOCAwIFIKPj4KZW5kb2JqCjkgMCBvYmoKPDwKL1R5cGUgL0V4dEdTdGF0ZQovQk0gL05vcm1hbAovY2EgMQo+PgplbmRvYmoKMTAgMCBvYmoKPDwKL1R5cGUgL0V4dEdTdGF0ZQovQk0gL05vcm1hbAovQ0EgMQo+PgplbmRvYmoKMTEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZ"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RichiestaComunicazionePec"},"success":{"type":"boolean","description":"Esito positivo dell'operazione (vero/falso)."},"message":{"type":"string","description":"messaggio di errore"},"error":{"type":"integer","description":"codice di errore"}}},"example":{"data":{"casella_pec":"mypec@pec.com","pec_amministratore":false,"cf":"RSSMRA80A01L117D","nome":"mario","cognome":"rossi","qualifica":"LEGALE_RAPPRESENTANTE","email":"mail@domain.com","cellulare":"34xxxxx018","ragione_sociale":"azienda test","cf_piva":"12345678910","comune":"roma","provincia":"RM","callback":false,"stato":"documenti_caricati","codice_registro_imprese":"openapi","documenti_registro_imprese":["60dc8da86c8b04624536bbb2_0_registro_imprese.p7m"],"owner":"mail@domain.com","timestamp":1625067055,"id":"60dc8da86c8b04624536bbb2"},"success":true,"message":"","error":null}}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"success":false,"message":"Wrong id","error":353,"data":null}}}},"404":{"description":"Not Found","content":{"application/json":{"example":{"success":false,"message":"no request found","error":354,"data":null}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"examples":{"wrong_stato":{"value":{"success":false,"message":"you can only upload documents when stato is 'in_attesa_di_documenti'","error":355,"data":null}},"wrong_file_format":{"value":{"success":false,"message":"wrong file format, p7m required","error":402,"data":null}}}}}},"428":{"description":"Precondition Required","content":{"application/json":{"examples":{"id_required":{"value":{"success":false,"message":"id required","error":352,"data":null}},"documenti_required":{"value":{"success":false,"message":"documenti required","error":356,"data":null}},"documenti_empty":{"value":{"success":false,"message":"documenti empty","error":401,"data":null}}}}}}}}},"/pec/{id}/modulo_attivazione":{"get":{"tags":["Modulistica"],"summary":"Scarica il modulo di attivazione","description":"Questo metodo consente di scaricare direttamente il modulo di attivazione di una posta elettronica certificata. Una volta compilato e firmato, il modulo verrà inviato sotto forma di stringa codificata in base 64 tramite il metodo PATCH/pec/{id}/attivazione, insieme a un documento di identità.","parameters":[{"name":"id","in":"path","description":"ID richiesta","required":true,"schema":{"type":"string","example":"5f7b2e323a716857774a4373"}}],"responses":{"200":{"description":"Un file PDF","headers":{"Content-Disposition":{"schema":{"type":"string"},"example":"attachment; filename=\"modulo_attivazione.pdf\""}},"content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"success":false,"message":"Wrong id","error":201,"data":null}}}},"404":{"description":"Not Found","content":{"application/json":{"example":{"success":false,"message":"no pec found","error":202,"data":null}}}},"428":{"description":"Precondition Required","content":{"application/json":{"examples":{"wrong_stato_infocert":{"value":{"success":false,"message":"you can activate the pec only when it is in the 'registrata|documenti_errati' state","error":537,"data":null}},"wrong_stato_namirial":{"value":{"success":false,"message":"you can activate the pec only when it is in the 'registrata|documenti_errati' state","error":598,"data":null}},"pdf_generation_failed_namirial":{"value":{"success":false,"message":"Errore nella generazione del modulo","error":601,"data":null}}}}}}}}},"/pec/{id}/modulo_conservazione":{"get":{"tags":["Modulistica"],"summary":"Scarica il modulo di attivazione","description":"Questo metodo consente di scaricare direttamente il modulo di attivazione della conservazione per una posta elettronica certificata. Una volta compilato e firmato, il modulo deve essere inviato come stringa codificata in base64 tramite il metodo PATCH all’endpoint /pec/{id}/conservazione.","parameters":[{"name":"id","in":"path","description":"ID richiesta","required":true,"schema":{"type":"string","example":"5f7b2e323a716857774a4373"}}],"responses":{"200":{"description":"Un file PDF","headers":{"Content-Disposition":{"schema":{"type":"string"},"example":"attachment; filename=\"modulo_conservazione.pdf\""}},"content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"success":false,"message":"Wrong id","error":201,"data":null}}}},"404":{"description":"Not Found","content":{"application/json":{"example":{"success":false,"message":"no pec found","error":202,"data":null}}}},"428":{"description":"Precondition Required","content":{"application/json":{"examples":{"wrong_stato_infocert":{"value":{"success":false,"message":"you can activate this service only if the pec has been processed","error":538,"data":null}},"wrong_stato_namirial":{"value":{"success":false,"message":"you can activate this service only if the pec has been processed","error":599,"data":null}},"pdf_generation_failed_namirial":{"value":{"success":false,"message":"Errore nella generazione del modulo","error":601,"data":null}}}}}}}}},"/comunica_pec/{id}/procura_registro_imprese":{"get":{"tags":["Modulistica"],"summary":"Scarica la procura","description":"Questo metodo consente di scaricare il modulo di comunicazione PEC dal registro delle imprese. Una volta firmato digitalmente in formato p7m, il modulo verrà inviato sotto forma di stringa codificata in base 64 utilizzando il metodo PATCH/comunica_pec/{id}.","parameters":[{"name":"id","in":"path","description":"ID richiesta","required":true,"schema":{"type":"string","example":"5f7b2e323a716857774a4373"}}],"responses":{"200":{"description":"Se il modulo firmato è già stato caricato, restituisce il PDF salvato. In caso contrario (e se \"stato\" non è uguale a \"codice_in_richiesta\"), restituisce il record della richiesta in formato JSON anziché un file.","headers":{"Content-Disposition":{"schema":{"type":"string"},"example":"attachment; filename=\"5f7b2e323a716857774a4373_procura_registro_imprese.pdf\""}},"content":{"application/pdf":{"schema":{"type":"string","format":"binary"}},"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RichiestaComunicazionePec"},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer","nullable":true}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"success":false,"message":"Wrong id","error":333,"data":null}}}},"404":{"description":"Not Found","content":{"application/json":{"example":{"success":false,"message":"no request found","error":334,"data":null}}}},"406":{"description":"Not Acceptable — il modulo non può ancora essere generato perché la richiesta è ancora nello stato “codice_in_richiesta”. Restituito come corpo di testo semplice, non come involucro JSON.","content":{"text/plain":{"schema":{"type":"string"},"example":"you cannot download this module, it doesn't exist yet"}}}}}}},"externalDocs":{"description":"È la prima volta che visiti questo sito? Genera un nuovo token di accesso","url":"https://console.openapi.com/it/oauth"},"security":[{"bearerAuth":[]}]}