Tutti i documenti ufficiali del Registro Imprese, delle Agenzia delle Entrate e degli Istituti Previdenziali.
Ottieni in tempo reale i documenti certificati su aziende, persone, immobili.
Tutte le informazioni di cui hai bisogno
Qui trovi qualche consiglio da prendere in considerazione per approcciare a questa API. Se preferisci forniamo esempi di codice, documentazione in OAS3, la possibilità di provare l'API dal vivo con la Swagger UI oppure importare l'intera collezione in Postman. Offriamo inoltre un ambiente di Sandbox dove puoi sperimentare tutte le API gratuitamente.
Utili consigli per iniziare con
DocuEngine
Prendi il token nell'apposita sezione prima di cominciare.
Usa lo strumento online o generalo via API. Imposta una data di scadenza e aggiungi una serie di Scopes per limitare le possibli azioni permesse al token.
Ottieni l'elenco dei documenti disponibili
Docuengine offre molti tipi di documento, per ottenerne un elenco
basta una chiamata a /documents.
Il risultato conterrà un elenco di documenti disponibli identificati da un nome, una categoria e un {id} (ovvero un identificativo univoco del tipo di documento), il prezzo del documento, il prezzo della ricerca (se presente "hasSearch": true), se si tratta di un servizio sincrono "isSync" l'elenco dei campi di input con relativa spiegazione ed istruzioni per la validazione "requestStructure" e le opzioni disponibili "options".
Presta attenzione all'elenco dei campi "fields" in "requestStructure" perchè in base alle regole di validazioni "validation" saranno i campi necessari da compilare in fase di richiesta.
Il risultato conterrà un elenco di documenti disponibli identificati da un nome, una categoria e un {id} (ovvero un identificativo univoco del tipo di documento), il prezzo del documento, il prezzo della ricerca (se presente "hasSearch": true), se si tratta di un servizio sincrono "isSync" l'elenco dei campi di input con relativa spiegazione ed istruzioni per la validazione "requestStructure" e le opzioni disponibili "options".
Presta attenzione all'elenco dei campi "fields" in "requestStructure" perchè in base alle regole di validazioni "validation" saranno i campi necessari da compilare in fase di richiesta.
Hai scelto quale documento vuoi ottenere? Effettua la tua prima richiesta!
Ora che conosciamo l'{id} del documento che intendiamo richiedere passiamo a preparare la nostra richiesta /requests.
I dati minimi necessari sono infatti "documentId" di cui abbiamo parlato e "search" che consiste nei dati di input del servizio.
Nel seguente esempio stiamo richiedendo uno "Stauto" indicando che il campo "field0" ovvero "taxCode" è uguale a "12485671007" ovvero il codice fiscale dell'azienda di cui stiamo richiedendo il documento. La spiegazione dei campi presenti in ogni visura è ottenibile allo step precedente
La risposta che si otterrà conterrà un campo "id" che rappresenta l'identificativo univoco della richiesta oltre ad informazioni sullo stato "state"
Per alcuni tipi di richeista possono essere presenti eventuali risultati multipli "results" tra i quali scegliere. Questo scenario è possibile quando a fronte dell'inserimento di una richiesta sono disponibili più documenti come nel caso dei bilanci in cui è possibile selezionare l'anno di riferimento o nel caso di ricerche catastali a partire da un codice fiscale è possible selezionare per quale immobile di proprietà si vuole ottenere la visura. Solo in questo secondo caso sarà necessaria una successiva richiesta in "PATCH" /requests/{id} indicando l'{id} della richiesta nel "path" ed il "resultId" dei "results" della ricerca nel body.
I dati minimi necessari sono infatti "documentId" di cui abbiamo parlato e "search" che consiste nei dati di input del servizio.
Nel seguente esempio stiamo richiedendo uno "Stauto" indicando che il campo "field0" ovvero "taxCode" è uguale a "12485671007" ovvero il codice fiscale dell'azienda di cui stiamo richiedendo il documento. La spiegazione dei campi presenti in ogni visura è ottenibile allo step precedente
{ "documentId": "6687eed51a241a5d1be0f9fa", "search": { "field0": "12485671007" } }Si consiglia caldamente di compilare anche la sezione callback per ricevere in maniera asincrona gli aggiornamenti di stato della richiesta visto che i tempi di risposta possono variare in base al tipo di documento.
La risposta che si otterrà conterrà un campo "id" che rappresenta l'identificativo univoco della richiesta oltre ad informazioni sullo stato "state"
Per alcuni tipi di richeista possono essere presenti eventuali risultati multipli "results" tra i quali scegliere. Questo scenario è possibile quando a fronte dell'inserimento di una richiesta sono disponibili più documenti come nel caso dei bilanci in cui è possibile selezionare l'anno di riferimento o nel caso di ricerche catastali a partire da un codice fiscale è possible selezionare per quale immobile di proprietà si vuole ottenere la visura. Solo in questo secondo caso sarà necessaria una successiva richiesta in "PATCH" /requests/{id} indicando l'{id} della richiesta nel "path" ed il "resultId" dei "results" della ricerca nel body.
{"resultId": "59eabaa38b9571eaa2520ad96672e8ee"}
Scarica il documento una volta pronto!
Appena la richiesta raggiunge lo stato "state" di "DONE" diventano disponibili i documenti per il download.
Basta una chiamata a /requests/{id}/documents per ottenere l'elenco dei documenti disponibili per il download.
Basta una chiamata a /requests/{id}/documents per ottenere l'elenco dei documenti disponibili per il download.
[ { "fileName": "5f22f5b5065afc21cc60a27a_0.pdf", "mimeType": "application/pdf", "fileSize": "34144", "md5": "IPJJgdrAt4xrvGR4ve7oTg==", "urlExpire": 1724505599, "downloadUrl": "https://storage.googleapis.com/docuengine-openapi-com/documents/5f22f5b5065afc21cc60a27a_0.pdf?X-Goog-Algorithm=GOOG4-RSA-SHA256&...." } ]
- Oas file url https://console.openapi.com/oas/it/docuengine.openapi.json
- Production domain docuengine.openapi.com
- Sandbox domain test.docuengine.openapi.com
- Production Scopes 4
-
Sandbox Scopes 4
- GET test.docuengine.openapi.com/documents
- POST test.docuengine.openapi.com/requests
- PATCH test.docuengine.openapi.com/requests
- GET test.docuengine.openapi.com/requests
Redoc missing.