Tous les documents officiels des Registres du Commerce, des Administrations Fiscales et des Instituts de Sécurité Sociale.
Obtenez en temps réel des documents officiels sur des entreprises, des particuliers et des biens immobiliers.
Toutes les connaissances dont vous avez besoin
Vous trouverez ici quelques conseils à prendre en compte pour aborder cette API. Si vous préférez, nous fournissons des exemples de code, la documentation OAS3, la possibilité d'essayer l'API en direct via Swagger UI ou d'importer l'intégralité de la collection dans Postman. Nous proposons également un environnement Sandbox où vous pouvez expérimenter toutes sortes de requêtes de manière totalement gratuite.
Conseils utiles pour commencer
DocuEngine
Obtenir le Token dans la section appropriée avant de commencer.
Utilisez l'outil en ligne ou générez-le via l'API. Définissez la date d'expiration, un nom utile et ajoutez maintenant un ensemble d'étendues pour limiter les actions possibles que votre jeton peut effectuer.
Obtenez la liste des documents disponibles
Docuengine propose de nombreux types de documents. Pour obtenir une liste,
il suffit d'effectuer un appel à /documents.
Le résultat contiendra une liste de documents disponibles identifiés par un nom, une catégorie et un {id} (identifiant unique du type de document), le prix du document, le prix de la recherche (si présent "hasSearch": true), s'il s'agit d'un service synchrone "isSync", la liste des champs d'entrée avec leur description et les instructions de validation "requestStructure" et les options disponibles "options".
Portez une attention particulière à la liste des champs "fields" dans "requestStructure" car en fonction des règles de validation "validation", ce seront les champs obligatoires à remplir lors de la demande.
Le résultat contiendra une liste de documents disponibles identifiés par un nom, une catégorie et un {id} (identifiant unique du type de document), le prix du document, le prix de la recherche (si présent "hasSearch": true), s'il s'agit d'un service synchrone "isSync", la liste des champs d'entrée avec leur description et les instructions de validation "requestStructure" et les options disponibles "options".
Portez une attention particulière à la liste des champs "fields" dans "requestStructure" car en fonction des règles de validation "validation", ce seront les champs obligatoires à remplir lors de la demande.
Vous avez choisi le document que vous souhaitez obtenir ? Effectuez votre première requête !
Maintenant que nous connaissons l'{id} du document que nous souhaitons demander, passons à la préparation de notre requête /requests.
Les données minimales requises sont en effet "documentId" que nous avons mentionné précédemment et "search" qui consiste en les données d'entrée du service.
Dans l'exemple suivant, nous demandons un "Statut" en indiquant que le champ "field0" c'est-à-dire "taxCode" est égal à "12485671007" soit le numéro de TVA de la société pour laquelle nous demandons le document. L'explication des champs présents dans chaque rapport peut être obtenue à l'étape précédente
La réponse que vous obtiendrez contiendra un champ "id" qui représente l'identifiant unique de la requête ainsi que des informations sur l'état "state"
Pour certains types de requêtes, il peut y avoir plusieurs "results" parmi lesquels choisir. Ce scénario est possible lorsqu'en réponse à une requête, plusieurs documents sont disponibles, comme dans le cas des états financiers où vous pouvez sélectionner l'année de référence ou dans le cas de recherches cadastrales à partir d'un numéro de TVA, il est possible de sélectionner pour quel immeuble vous souhaitez obtenir le rapport. Seulement dans ce deuxième cas, une requête "PATCH" supplémentaire sera nécessaire /requests/{id} en indiquant l'{id} de la requête dans le "path" et le "resultId" des "results" de la recherche dans le corps.
Les données minimales requises sont en effet "documentId" que nous avons mentionné précédemment et "search" qui consiste en les données d'entrée du service.
Dans l'exemple suivant, nous demandons un "Statut" en indiquant que le champ "field0" c'est-à-dire "taxCode" est égal à "12485671007" soit le numéro de TVA de la société pour laquelle nous demandons le document. L'explication des champs présents dans chaque rapport peut être obtenue à l'étape précédente
{ "documentId": "6687eed51a241a5d1be0f9fa", "search": { "field0": "12485671007" } }Il est fortement recommandé de remplir également la section de rappel pour recevoir des mises à jour d'état de la requête de manière asynchrone, car les temps de réponse peuvent varier en fonction du type de document.
La réponse que vous obtiendrez contiendra un champ "id" qui représente l'identifiant unique de la requête ainsi que des informations sur l'état "state"
Pour certains types de requêtes, il peut y avoir plusieurs "results" parmi lesquels choisir. Ce scénario est possible lorsqu'en réponse à une requête, plusieurs documents sont disponibles, comme dans le cas des états financiers où vous pouvez sélectionner l'année de référence ou dans le cas de recherches cadastrales à partir d'un numéro de TVA, il est possible de sélectionner pour quel immeuble vous souhaitez obtenir le rapport. Seulement dans ce deuxième cas, une requête "PATCH" supplémentaire sera nécessaire /requests/{id} en indiquant l'{id} de la requête dans le "path" et le "resultId" des "results" de la recherche dans le corps.
{"resultId": "59eabaa38b9571eaa2520ad96672e8ee"}
Téléchargez le document une fois prêt !
Dès que la requête atteint l'état "state" de "DONE", les documents deviennent disponibles pour le téléchargement.
Il suffit d'effectuer un appel à /requests/{id}/documents pour obtenir la liste des documents disponibles pour le téléchargement.
Il suffit d'effectuer un appel à /requests/{id}/documents pour obtenir la liste des documents disponibles pour le téléchargement.
[ { "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/fr/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.