€9.90 + VAT
Offer via API to your customers/employees the online Family Status Certificate service in a secure, fast and simple way. The service is managed by selected and recognised CAFs or Patronati and everything is done 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. Since the processing is manually handled by operators, the time required depends on the complexity of the request. Openapi ensures that the entire process complies with the applicable privacy regulations, implementing data minimization and encryption practices.
The Family Status Certificate contains the main details of individuals registered at the same address within the same property unit (regardless of their familial relationship). It is required for various administrative, legal, and fiscal procedures.
There are two separate services available for requesting the Family Status Certificate: one with stamp duty exemption and one with stamp duty. In case of stamp duty exemption, it is necessary to provide the reason for the exemption (e.g., pension or legal proceedings) and, if required, a document proving the right to exemption.
Openapi makes it easy and quick to request the Family Status Certificate. By integrating our APIs, you can offer your customers an efficient and secure service to request and receive the certificate directly within your systems.
The request can be submitted directly by the applicant or through selected and recognized CAFs and Patronati (with authorization).
GET /documents
To request the Family Status Certificate with Docuengine, you must first verify all parameters to correctly complete the request.
https://docuengine.openapi.com/documents
This can be done via the endpoint GET /documents, which requires no parameters and returns the full list of documents and procedures available through Docuengine, along with their respective parameters and costs.
GET /documents
The response will provide all necessary information to complete the request for the available documents through the Docuengine API. In our case, we will focus only on the data for the Family Status 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 Stato Di Famiglia",
"options": [
{
"name": "urgenza",
"price":4
},
{
"name": "assistenza_dedicata",
"price": 10
}
],
"hasSearch": false,
"isSync": false,
"id": "67d0664a2cbb7e30d3d93e2b",
"searchPrice": 0,
"documentPrice": 9.90,
"totalPrice": 9.90
}
],
"success": true,
"message": "",
"error": null
}
The validation process specifies the required data to successfully complete the request.
The required data for the request are:
Any additional required documents will be requested by the CAF or Patronato managing the request in compliance with privacy regulations.
POST /requests
POST /requests
{
"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"
}
}
POST /requests
The response provides various information, including the status, whether a callback is set, and the request ID, which will be needed later 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 Stato di Famiglia",
"hasSearch": false,
"searchPrice": 0,
"documentPrice": 9.90,
"totalPrice": 9.90,
"documents": null,
"resultId": null,
"results": null,
"id": "67d0664a2cbb7e30d3d93e2b"
},
"success": true,
"message": "",
"error": null
}
PATCH /requests/{_id}
By default, if the "STATE" field is not set, the transaction is considered immediately closed, and your request will be processed and completed. However, if the state is set, the transaction starts but remains open, allowing you to update the request using the endpoint PATCH /requests/{_id}.
PATCH /requests/{_id}
This endpoint allows you to update certain fields in the request and complete the process: either closing it if the status is "NEW" or selecting a result from a search if the document has the 'hasSearch' parameter set to true.
{
"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 Stato di Famiglia,
"hasSearch": false,
"searchPrice": 0,
"documentPrice": 9.9,
"totalPrice": 9.9,
"documents": null,
"resultId": null,
"results": null,
"id": "67d0664a2cbb7e30d3d93e2b"
},
"success": true,
"message": "",
"error": null
}
When the request is in "processed" status, the document can be downloaded in PDF format. The endpoint that allows downloading documents generated from the request is: GET/requests/{id}/documents
The response will include the file name, size, and the download URL.
{
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"
}
The PDF file is provided in Base64-encoded format.
By integrating Openapi's APIs, companies can offer their customers an efficient and compliant service for requesting the Family Status Certificate, leveraging the professional management of recognized CAF and Patronati.
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 Family Status Certificate, which certifies the composition of a household residing at the same address, regardless of the familial relationship.
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 Family Status Certificate 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 stamp.