€9.90 + VAT
Integrate via API and online the Certificate of Registry Residence service (Ordinary and Historical) in a fast, secure and simple way. Service managed by selected and recognised CAFs or Patronati, in full compliance with regulations.
Openapi allows access to all major Civil Status Certificates, such as the Residence Certificate, Family Status Certificate, and Marriage Certificate. Civil status certificates are official documents that certify and attest to a person's civil status, residence, and other data related to the individual registered with the municipality of residence.
The service is provided via API directly by an authorized professional, and the processing times, as these are manual tasks performed by operators, depend on the complexity of the procedure. Openapi ensures that the entire process is carried out in full compliance with current privacy regulations, with data minimization and encryption measures in place.
The residence certificate attests to the current registered residence of an individual and is required for various administrative, legal, and tax procedures. The historical residence certificate, on the other hand, provides information about a person's previous residence in a specific municipality.
Separate services are available for requesting the Registered Residence Certificate with or without stamp duty, and the Historical Residence Certificate with or without stamp duty. In case of stamp duty exemption, the reason for the exemption (e.g., pension or legal process) will need to be provided, along with any supporting document proving the right to exemption.
Openapi allows you to request the Residence Certificate easily and quickly. Thanks to the integration of our APIs, you can offer your clients an efficient and secure service to request and receive the certificate directly within your systems.
The request can be submitted directly by the declarant or through selected and recognized CAFs (Tax Assistance Centers) and Patronages (with delegation).
GET /documents
To request the Residence Certificate with Docuengine, you must first verify all the parameters required to complete the request properly.
https://docuengine.openapi.com/documents
This is possible via the GET /documents endpoint, which requires no parameters and will return the full list of documents and procedures that can be requested via Docuengine, along with their respective parameters and costs.
GET /documents
The response will include all the necessary information to complete the request for documents available through the Docuengine API. In our case, we will be interested only in the data for the Residence Certificate.
{
"data": [
{
"requestStructure": {
"fields": {
"field0": {
"name": "name",
"nameIT": "nome",
"type": "string",
"required": true,
"options": null,
"help": "Inserire il nome del richiedente"
},
"field1": {
"name": "surname",
"nameIT": "cognome",
"type": "string",
"required": true,
"options": null,
"help": "Inserire il cognome del richiedente"
},
"field2": {
"name": "birthDate",
"nameIT": "data nascita",
"type": "date",
"required": true,
"options": null,
"help": "Inserire la data di nascita del richiedente"
},
"field3": {
"name": "birthTown",
"nameIT": "comune nascita",
"type": "string",
"required": true,
"options": null,
"help": "Inserire il comune di nascita del richiedente"
},
"field4": {
"name": "taxCode",
"nameIT": "codice fiscale",
"type": "string",
"required": true,
"options": null,
"help": "Inserire il codice fiscale del richiedente"
},
"field5": {
"name": "residenceTown",
"nameIT": "comune residenza",
"type": "string",
"required": true,
"options": null,
"help": "Inserire il comune di residenza del richiedente (nel caso di residenza all'estero il cliente deve riportare il comune di iscrizione AIRE"
},
"field6": {
"name": "exemptionReason",
"nameIT": "motivo esenzione",
"type": "date",
"required": true,
"options": [],
"help": "Inserire la data di nascita del secondo coniuge"
},
"field7": {
"name": "exemptionDocument",
"nameIT": "documento esenzione",
"type": "string",
"required": true,
"options": null,
"help": "Caricare il file che attesta il motivo dell'esenzione da marca da bollo"
},
"field8": {
"name": "notes",
"nameIT": "note",
"type": "string",
"required": false,
"options": null,
"help": "Note aggiuntive"
}
},
"validation": "",
"help": null,
"searchHelp": null
},
"category": "Patronato",
"name": "Certificato Residenza Anagrafica",
"options": [
{
"name": "urgenza",
"price":4
},
{
"name": "assistenza_dedicata",
"price": 10
}
],
"hasSearch": false,
"isSync": false,
"id": "67d066602cbb7e30d3d93e2f",
"searchPrice": 0,
"documentPrice": 9.90,
"totalPrice": 9.90
}
],
"success": true,
"message": "",
"error": null
}
In validation, the required data to successfully complete the request will be indicated.
The required data for the request are:
Additional documents required will be requested by the CAF or Patronage handling the procedure in accordance with privacy regulations.
POST /requests
POST /requests
{
"documentId": "67d066602cbb7e30d3d93e2f"
"search": {
"field0": "nome",
"field1": "cognome",
"field2": "data nascita",
"field3": "comune nascita",
"field4": "codice fiscale",
"field5": "comune residenza",
"field6": "motivo esenzione",
"field7": "documento esenzione",
"field8": "note"
}
}
POST /requests
The response will provide several pieces of information, including the status, whether the callback is set, and the request ID, which we will later use to download the document.
{
"data" {
"documentId": "66ffea9fa2b0bc1d3104fa54"
"search": {
"field0": "nome",
"field1": "cognome",
"field2": "data nascita",
"field3": "comune nascita",
"field4": "codice fiscale",
"field5": "comune residenza",
"field6": "motivo esenzione",
"field7": "documento esenzione",
"field8": "note"
},
"data": {}
},
"timestamps": {
"creation": 1724416377,
"WAIT": 1724416377,
"lastUpdate": 1724416393
},
"state": "WAIT",
"readableSearch": {},
"optionsPrice": 0,
"selectedOptions": null,
"notifyEmail": null,
"name": "Certificato Residenza Anagrafica",
"hasSearch": false,
"searchPrice": 0,
"documentPrice": 9.90,
"totalPrice": 9.90,
"documents": null,
"resultId": null,
"results": null,
"id": "67d066602cbb7e30d3d93e2f"
},
"success": true,
"message": "",
"error": null
}
PATCH /requests/{_id}
By default, if the "STATE" field is not filled, the transaction is considered immediately closed, and your request will be processed and completed. If set, the transaction will start but remain open, and you can proceed to update the request via the PATCH /requests/{_id} endpoint.
PATCH /requests/{_id}
This endpoint allows you to update specific fields of the request and complete the process: closing it if the status is "NEW," or selecting a result from the search if the document has the 'hasSearch' parameter set to true.
{
"data" {
"documentId": "67d066602cbb7e30d3d93e2f"
"search": {
"field0": "nome",
"field1": "cognome",
"field2": "data nascita",
"field3": "comune nascita",
"field4": "codice fiscale",
"field5": "comune residenza",
"field6": "motivo esenzione",
"field7": "documento esenzione",
"field8": "note"
},
"data": {}
},
"timestamps": {
"creation": 1724416377,
"WAIT": 1724416377,
"lastUpdate": 1724416393
},
"state": "WAIT",
"readableSearch": {},
"optionsPrice": 0,
"selectedOptions": null,
"notifyEmail": null,
"name": "Certificato Residenza Anagrafica,
"hasSearch": false,
"searchPrice": 0,
"documentPrice": 9.9,
"totalPrice": 9.9,
"documents": null,
"resultId": null,
"results": null,
"id": "67d066542cbb7e30d3d93e2d"
},
"success": true,
"message": "",
"error": null
}
Once the request is "completed," you can download the document in PDF format. The endpoint to download documents generated by the request is: GET/requests/{id}/documents
The response will provide the file name, size, and URL for downloading the file.
{
data{
"fileName":"5f22f5b5065afc21cc60a27a_0.pdf",
"mimeType"application/pdf",
"fileSize":"34144",
"md5":"application/pdf",
"urlExpire":"1724505599",
"downloadUrl":"https://storage.googleapis.com/test-docuengine-openapi-com/documents/5f22f5b5065afc21cc60a27a_0.pdf",
},
"success": true,
"message": "",
"error": null
}
The PDF file is provided in base64 encoded format.
The historical registry certificate may take up to 15 working days to process.
By integrating Openapi APIs, companies can offer their clients an efficient and compliant service for requesting the Residence Certificate, leveraging the professional management of recognized CAFs and Patronages.
Do you need help?
Haven't found the answer you're looking for?
Fill in all the details, we will get back to you as soon as possible!
The service allows the integration via API of the request for the Ordinary and/or Historical Residence Certificate. In the first case (ordinary), the document certifies the current residence of an individual, while in the second case (historical), it certifies the residence address related to the past, from a certain date onward, and verifies any changes of residence within the same municipality.
The service is fast, easy, and secure, and is managed by selected and recognized CAFs or Patronati, in compliance with regulations.
The service is part of Docuengine, the API for requesting over 128 official documents, benefits, and reports, with data coming from certified sources.
The main categories of documents available via Docuengine are as follows:
The services currently available on Openapi include:
The service is designed for companies that wish to easily integrate the request for Certificate of Registry Residence via API, providing their clients and employees with a quick and high-quality experience.
The application is entrusted to CAF and Patronati managed by authorized and specialized personnel, and everything is done in full compliance with privacy regulations.
Openapi manages the entire request process via API in full compliance with the current privacy regulations, with data minimization and encryption measures.
For more information, you can consult the Privacy documentation on our website.
The produced documents are deleted from Openapi's systems based on the timelines visible in the Redemption Period (the deadline after which the document is deleted from our servers) within the privacy documentation. If necessary, the client can contact the authorized Professional who provided the service, who is required to keep a copy in accordance with regulations.
The service is provided within 2 working days from the submission of the complete documentation.
The cost per single request is €9.90 with exemption, €25.90 with a revenue stamp.