All official documents from the Business Register, Revenue Agencies, and Social Security Institutions.
Get real-time official documents on companies, individuals, and properties.
All the knowledge you need
Here you can find some advice to consider to approach this API. If you prefer, we provide code samples, OAS3 documentation, the ability to try the API live via the Swagger UI or import the entire collection into Postman. We also offer a Sandbox environment where you can experiment with all kinds of requests completely free of charge.
Useful tips to start with
DocuEngine
Get the token in the appropriate section before you start.
Use the the online tool or generate it via API. Set the expire date, a usefull name and now add a bunch of scopes to limit the possible actions your token can do.
Get the list of available documents
Docuengine offers many types of documents. To get a list of them,
simply make a call to /documents.
The result will contain a list of available documents identified by a name, a category, and an {id} (a unique identifier for the document type), the document price, the search price (if present "hasSearch": true), whether it is a synchronous service "isSync", the list of input fields with their descriptions and validation instructions "requestStructure" and the available options "options".
Pay attention to the list of fields "fields" in "requestStructure" because based on the validation rules "validation" these will be the required fields to fill in when making a request.
The result will contain a list of available documents identified by a name, a category, and an {id} (a unique identifier for the document type), the document price, the search price (if present "hasSearch": true), whether it is a synchronous service "isSync", the list of input fields with their descriptions and validation instructions "requestStructure" and the available options "options".
Pay attention to the list of fields "fields" in "requestStructure" because based on the validation rules "validation" these will be the required fields to fill in when making a request.
Have you chosen which document you want to obtain? Make your first request!
Now that we know the {id} of the document we want to request, let's prepare our request /requests.
The minimum required data is actually "documentId" which we mentioned earlier and "search" which consists of the service input data.
In the following example, we are requesting a "Status" indicating that the field "field0" or "taxCode" is equal to "12485671007" which is the tax code of the company for which we are requesting the document. The explanation of the fields present in each report can be obtained in the previous step
The response you will get will contain an "id" field that represents the unique identifier of the request as well as information about the status "state"
For some types of requests, there may be multiple "results" from which to choose. This scenario is possible when multiple documents are available as a result of a request, such as in the case of financial statements where you can select the reference year or in the case of cadastral searches starting from a tax code it is possible to select for which property you want to obtain the report. Only in this second case will a subsequent "PATCH" request be necessary /requests/{id} indicating the {id} of the request in the "path" and the "resultId" of the "results" of the search in the body.
The minimum required data is actually "documentId" which we mentioned earlier and "search" which consists of the service input data.
In the following example, we are requesting a "Status" indicating that the field "field0" or "taxCode" is equal to "12485671007" which is the tax code of the company for which we are requesting the document. The explanation of the fields present in each report can be obtained in the previous step
{ "documentId": "6687eed51a241a5d1be0f9fa", "search": { "field0": "12485671007" } }It is highly recommended to also fill in the callback section to receive asynchronous status updates for the request, as response times may vary depending on the document type.
The response you will get will contain an "id" field that represents the unique identifier of the request as well as information about the status "state"
For some types of requests, there may be multiple "results" from which to choose. This scenario is possible when multiple documents are available as a result of a request, such as in the case of financial statements where you can select the reference year or in the case of cadastral searches starting from a tax code it is possible to select for which property you want to obtain the report. Only in this second case will a subsequent "PATCH" request be necessary /requests/{id} indicating the {id} of the request in the "path" and the "resultId" of the "results" of the search in the body.
{"resultId": "59eabaa38b9571eaa2520ad96672e8ee"}
Download the document once it's ready!
As soon as the request reaches the "state" of "DONE", the documents become available for download.
Simply make a call to /requests/{id}/documents to get the list of documents available for download.
Simply make a call to /requests/{id}/documents to get the list of documents available for 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/en/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.