€9.90 + TVA
Intégrez, via API et en ligne, le service de Certificat de Résidence Principal (ordinaire et historique) d'une manière rapide, sécurisée et simple. Service géré par des CAF ou des Patronati sélectionnés et reconnus, dans le respect total de la réglementation.
Openapi permet d’accéder à tous les principaux certificats d’état civil, tels que le certificat de résidence, le certificat de composition de ménage et le certificat de mariage. Les certificats d’état civil sont des documents officiels qui attestent et certifient l’état civil, la résidence et d’autres données relatives à la personne enregistrée auprès de la mairie de résidence.
Le service est fourni via une API directement par un professionnel habilité, et les délais, étant donné qu'il s'agit de travaux effectués manuellement par des opérateurs, dépendent de la complexité de la procédure. Openapi garantit que l'ensemble du processus se déroule dans le respect total de la législation en vigueur en matière de protection des données, avec des logiques de minimisation et de chiffrement des données.
Le certificat de résidence atteste de la résidence actuelle d'une personne physique et est nécessaire pour diverses démarches administratives, juridiques et fiscales. Le certificat de résidence historique, quant à lui, indique les informations relatives à la résidence antérieure d'une personne dans une commune donnée.
Des services distincts sont disponibles pour la demande de Certificat de Résidence Annuelle avec ou sans timbre fiscal, et de Certificat de Résidence Historique avec ou sans timbre fiscal. En cas d'exemption de timbre fiscal, il sera demandé de fournir la raison de l'exemption (par exemple, pension ou procédure judiciaire) et, éventuellement, un document prouvant le droit à l'exemption.
Openapi permet de demander le Certificat de Résidence de manière simple et rapide. Grâce à l'intégration de nos API, vous pouvez offrir à vos clients un service efficace et sécurisé pour demander et recevoir le certificat directement dans vos systèmes.
La demande peut être soumise directement par le déclarant ou via des CAF et des Associations de Protection Sociale sélectionnées et reconnues (avec procuration).
GET /documents
Pour demander le Certificat de Résidence avec Docuengine, il est d'abord nécessaire de vérifier tous les paramètres pour compléter correctement la demande.
https://docuengine.openapi.com/documents
Ceci est possible via l'endpoint GET /documents qui ne nécessite aucun paramètre et retournera la liste complète des documents et démarches disponibles via Docuengine, ainsi que leurs paramètres et coûts respectifs.
GET /documents
La réponse indiquera toutes les informations nécessaires pour compléter la demande des documents disponibles via l'API Docuengine. Dans notre cas, nous nous intéresserons uniquement aux données pour le Certificat de Résidence
{
"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
}
Les données obligatoires pour compléter la demande avec succès sont indiquées comme étant en validation.
Les données nécessaires pour la demande sont :
Les documents supplémentaires nécessaires seront demandés par le CAF ou l'Association de Protection Sociale qui gère la demande conformément à la législation sur la protection des données.
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
La réponse retournera plusieurs informations, y compris l'état, si le callback est défini et l'ID de la demande, que nous utiliserons plus tard pour télécharger le 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}
Par défaut, si le champ "STATE" n'est pas rempli, la transaction est immédiatement considérée comme fermée et votre demande sera traitée. Si ce champ est rempli, la transaction est lancée mais reste ouverte et vous pouvez alors procéder à la mise à jour de la demande via l'endpoint PATCH /requests/{_id}.
PATCH /requests/{_id}
Ce endpoint permet de mettre à jour certains champs de la demande et de finaliser le processus : la clôturer si l'état est "NEW", ou sélectionner un résultat généré par la recherche, si le document a le paramètre 'hasSearch' activé.
{
"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
}
Lorsque la demande est dans l'état "traitée", il est possible de télécharger le document en format PDF. L'endpoint qui permet de télécharger les documents générés par la demande est : GET/requests/{id}/documents
La réponse indiquera le nom du fichier, sa taille et l'URL pour télécharger le fichier.
{
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
}
Le fichier PDF est fourni au format codé en base64.
En intégrant les API d'Openapi, les entreprises peuvent offrir à leurs clients un service efficace et conforme pour demander le Certificat de Résidence, en profitant de la gestion professionnelle des CAF et des Associations de Protection Sociale reconnues.
Avez-vous besoin d'aide ?
Vous n'avez pas trouvé la réponse que vous cherchiez?
Remplissez tous les détails, nous vous contacterons dès que possible!
Le service permet d'intégrer via API la demande de Certificat de résidence Ordinaire et/ou Historique. Dans le premier cas (ordinaire), le document atteste de la résidence actuelle d'un individu, tandis que dans le second cas (historique), il certifie l'adresse de résidence relative au passé, à partir d'une certaine date, et vérifie les éventuels changements de résidence dans la même commune.
Le service est rapide, facile et sécurisé, et est géré par des CAF ou des associations sélectionnées et reconnues, conformément aux réglementations.
Les principales catégories de documents disponibles via Docuengine sont les suivantes:
Les services actuellement disponibles sur Openapi sont:
Le service s'adresse aux entreprises qui souhaitent intégrer facilement, via API, la demande de Certificat de Résidence, offrant à leurs clients et employés une expérience rapide et de qualité.
La demande est confiée à des CAF et Patronages gérés par du personnel autorisé et spécialisé, et tout se déroule dans le respect total des réglementations sur la confidentialité.
Openapi gère l'ensemble du processus de demande via API en pleine conformité avec la réglementation en vigueur en matière de confidentialité, avec des logiques de minimisation et de chiffrement des données.
Pour plus d'informations à ce sujet, il est possible de consulter la documentation sur la confidentialité sur notre site Web.
Les documents produits sont supprimés des systèmes Openapi en fonction des délais visibles dans le Période de Rétention (le délai au-delà duquel le document est supprimé de nos serveurs) dans la documentation sur la confidentialité.
En cas de besoin, le client peut s'adresser directement au Professionnel habilité qui a fourni le service et qui est tenu de conserver une copie conformément à la réglementation.
Le service est fourni dans un délai de 20 jours ouvrable à compter de la remise de la documentation complète.
Le coût par requête est de 40€.