Partner API for Digiposte+, La Poste's certified digital safe (coffre-fort numerique a valeur probante). Lets an issuer create and manage memberships, deposit certified documents into a user's vault, run organisation safes and sharing spaces, and drive partner enrolment procedures.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/digiposte-v3"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
{
"openapi": "3.0.0",
"info": {
"description": "**Bienvenue sur l’API Coffre-fort numérique Digiposte +.**\n\n\n\nCette API permet d’envoyer et archiver des documents certifiés dans un coffre-fort numérique Digiposte + à valeur probante, pour vos clients ou utilisateurs.\n\nQue vous émettiez des factures, des attestations, des relevés, des avis… ou de simples courriers numériques, proposez à vos utilisateurs de les archiver automatiquement dans un coffre-fort numérique Digiposte +, dans lequel ils pourront centraliser tous leurs documents. Vous pouvez confier à Digiposte + la responsabilité de l’archivage de vos documents clients et vous concentrer sur votre cœur de métier, tout en offrant un service innovant à vos clients.\n\nDigiposte +, c’est :\n\n- Un véritable coffre-fort numérique pour vos utilisateurs, pour conserver et retrouver leurs documents.\n\n- Un assistant personnel qui leur simplifiera les démarches administratives et quotidiennes.\n\n### Comment ça se passe pour vos utilisateurs ou vos clients ?\n\nDepuis votre site ou application, vous intégrez un bouton ou un lien (voir la partie Charte d'intégration).\n\nVotre utilisateur, en cliquant sur le bouton ou le lien, sera redirigé vers un parcours de consentement. S’il n’a pas de compte Digiposte +, il sera invité à créer un compte, sinon, à se connecter. Une fois cette étape terminée, vous pouvez le rediriger vers votre site.\n\nEnsuite, à chaque fois que vous enverrez un document dans Digiposte + via les APIs de dépôt certifié, votre utilisateur recevra une notification (email et mobile) pour le prévenir.\nUn dossier sera automatiquement créé dans son coffre-fort Digiposte +, du nom de votre service, et tous les documents que vous enverrez y seront automatiquement archivés et classés.\n\nLes documents que vous envoyez dans Digiposte via l’API de dépôt certifié seront identifiés par un sigle « certifié La Poste », qui assure l’identité de l’émetteur (votre service) et la non altération du document pendant le process de dépôt et pendant toute sa durée de conservation. Vos utilisateurs bénéficieront ainsi d’un original numérique (ou copie certifiée conforme si vous conservez également le document dans votre espace client).\n\n## Les étapes à suivre pour intégrer nos APIs:\n\n### L’inscription\n\nPour commencer à utiliser les APIs, vous devez :\n\n- Disposer d’un compte « [La Poste Developer](https://developer.laposte.fr) » (inscription en libre-service sur ce site).\n\n- Souscrire à l’application Coffre-fort numérique Digiposte + sur ce site « [La Poste Developer](https://developer.laposte.fr) ».\n\n- Générer une clé d’application « [La Poste Developer](https://developer.laposte.fr) » pour pouvoir consommer les ressources. Cette clé est associée au compte crée,\net doit être utilisée dans le header `X-Okapi-Key` à chaque requête.\n\nNote : « Emetteur » est le nom donné au service qui veut envoyer (déposer) des documents dans un coffre-fort utilisateur Digiposte +. En l’occurrence, l’émetteur, c’est votre service.\n\nVous pouvez dès à présent utiliser l'émetteur de recette `OKAPI` pour tester votre raccordement, et développer vos premiers de dépôt de documents avec cet émetteur.\n\n**Plateforme de recette « interop » :**\n\nLa plateforme de recette est accessible pour créer des comptes Digiposte factices :\n\nhttps://secure.interop.u-post.fr/inscription-plus\n\net\n\nhttps://secure.interop.u-post.fr/identification-plus\n\n**Émetteur de recette « OKAPI » :**\n\n`client_id: \"okapi\"`\n\n`client_secret : \"6mstVSvc38wq\"`\n\n`sender_PID : \"OKAPI\"`\n\nLes exemples ci-dessous utiliseront ces identifiants émetteurs.\n\nLa clé OKAPI `RXu1BMRbOmkB7uT+FNj3Sijtk7mgn/MuJWVFmcfoloi0n/zLy2++V/nm6gatpQzX` n'est pas fonctionnelle,\nil faut la remplacer par la vôtre, dans tous les appels de service ci-dessous.\n\n### La validation de votre demande\n\nEn tant que futur émetteur de documents certifiés Digiposte, des vérifications doivent être réalisées.\n\nPour cela, vous devez nous transmettre un certain nombre d'éléments qui serviront à établir votre statut d'émetteur.\n\nEnvoyez votre demande d’accès à [digiposte.api@laposte.fr](mailto:digiposte.api@laposte.fr) avec les informations suivantes :\n\n- Code SIRET/SIREN\n\n- Nom de la société\n\n- Description de votre activité et projet avec Digiposte + (notamment la durée de conservation légale souhaitée de vos documents)\n\n- url de votre site web ou application mobile\n\n- url de votre logo (format 190x80px)\n\n- Coordonnées de contact (Nom, Prénom, Fonction, email, téléphone, adresse)\n\nDigiposte vous répondra dans les 2 jours ouvrés suivant votre demande. Sous réserve de l’acceptation de votre dossier, Digiposte vous fournira la clé API pour l’utilisation de ses APIs, ainsi que les informations pour l’environnement de préprod.\n\n### L’intégration\n\n**La recette**\n\nUne fois votre demande validée, Digiposte vous fournira les informations nécessaires à votre raccordement en tant\nqu'émetteur en recette.\n\n**La mise en production**\n\nUne fois la recette validée, Digiposte vous fournira les informations nécessaires à la mise en production.\n\n## Charte d’intégration\n\nL’utilisation du logo et de la marque Digiposte + est soumise au respect de la charte d’intégration. Cette charte a pour objectif de vous fournir les guidelines d’intégration afin d’améliorer l’expérience utilisateur.\n\n### Intégration du bouton ou du lien sur votre espace client :\n\n« Archivez mes documents dans un coffre-fort numérique Digiposte + ». Vous pouvez remplacer « documents » par un type plus précis de documents (factures, relevés, avis…) en fonction de votre service.\n\n### Description du service Digiposte +\n\nPour informer dès le début du parcours vos utilisateurs, vous pouvez insérer une courte description du service Digiposte +, en vous inspirant du contenu ci-dessous :\n\nDigiposte + est un véritable coffre-fort numérique dans lequel vous pourrez conserver et retrouver vos documents en sécurité. L’archivage de vos documents de « nom de votre service » est gratuit, et pour vos autres documents, vous bénéficiez de 5Go de stockage gratuit. Au-delà, de nombreuses autres fonctionnalités font de Digiposte + un assistant personnel qui vous simplifie la gestion administrative au quotidien.\nMessage de redirection\nUne fois le consentement effectué, vous pouvez rediriger votre utilisateur vers votre site. Il est recommandé de lui indiquer un message de confirmation de type « Votre demande a bien été prise en compte, vous recevrez vos documents dans votre compte Digiposte + ».\n\n### Résiliation de l’adhésion\n\nSi l’utilisateur ne souhaite plus recevoir de documents dans son compte Digiposte +, il peut résilier l’adhésion dans son compte Digiposte +, depuis le web, dans mon profil / mes applications.\nSinon, vous pouvez également proposer un bouton ou un lien « Résilier l’adhésion à Digiposte + » depuis votre site connecté, pour vos utilisateurs qui ont une adhésion active avec Digiposte +.\n\n## Principes du dépôt de document certifié\n\nUne fois raccordé, pour pouvoir déposer un document certifié, un émetteur doit :\n\n- Obtenir un jeton d'accès à un compte abonné Digiposte (Authentification)\n\n- Créer une adhésion à un flux documentaire (Adhésion)\n\n- Utiliser le code de routage généré pour transmettre un nouveau document à l'abonné (Dépôt)",
"title": "Digiposte v3",
"version": ""
},
"servers": [],
"paths": {
"/digiposte/v3/document/certified": {
"post": {
"parameters": [
{
"description": "e.g. RXu1BMRbOmkB7uT+FNj3Sijtk7mgn/MuJWVFmcfoloi0n/zLy2++V/nm6gatpQzX",
"example": "RXu1BMRbOmkB7uT+FNj3Sijtk7mgn/MuJWVFmcfoloi0n/zLy2++V/nm6gatpQzX",
"in": "header",
"name": "X-Okapi-Key",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. ed249df4e1a149c9bc213bd9b4289a73",
"example": "ed249df4e1a149c9bc213bd9b4289a73",
"in": "header",
"name": "X-RouteCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "X-Api-Version-Minor",
"required": false,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/okapiKeyParameter"
}
],
"responses": {
"200": {
"content": {
"application/json; charset=utf-8": {
"examples": {
"response": {
"value": {
"document": {
"algo": "SHA1",
"archive_duration": "2020-07-26T13:27:45.690",
"author_tags": "préfecture,essonne",
"file_name": "test.pdf",
"file_size": "140939",
"hash": "e6122b1d8abd2afbeed93fb4672af8b23a5f56b6",
"id_routage": "c441f90e99ca4f958131f1ed31e8fd65",
"title": "Passeport certifié",
"type": "PASSEPORT"
}
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"tags": [],
"description": "Les contrôles d'intégrité sont assurés grâce à la taille du document et le calcul préalable d'une empreinte\ndu document, et transmis par le truchement des paramètres obligatoires suivants :\n\n- `file_size`: taille du document transmis en octets\n\n- `algo`: algorythme utilisé pour le calcul de l'empreinte (MD5, SHA1, SHA256 ou SHA512)\n\n- `hash`: Empreinte de contrôle du document\n\nPar défaut, si aucune valeur `archive_duration` n'est spécifiée, la durée d'archivage légale du type de\ndocument s'applique. Quand la durée est atteinte, le document est conservé mais sa taille compte alors\ndans le quota de stockage de l'abonné.\n\nLes `author_tags`peuvent être spécifiés pour permettre à l'abonné de rechercher ses documents par mots-clés.\n\nExemple de requête curl correspondant à l'appel décris ici :\n\n```\ncurl --header \"X-Okapi-Key: RXu1BMRbOmkB7uT+FNj3Sijtk7mgn/MuJWVFmcfoloi0n/zLy2++V/nm6gatpQzX\" \\\\\n --header \"Authorization: bearer 16fc0b67-ca75-4082-b6ba-2079db1ce34d\" \\\\\n --header \"X-Dgp-UserId: 185fe86953e94e2692838a5f7cbff298\"\\\\\n --header 'X-RouteCode: ed249df4e1a149c9bc213bd9b4289a73' \\\\\n --header 'X-Api-Version-Minor: 2' \\\\\n --header \"Content-Type:multipart/form-data\" \\\\\n -X POST http://api.laposte.fr/digiposte/v3/document/certified \\\\\n --form 'title=Passeport certifié' --form 'type=PASSEPORT' \\\\\n --form 'algo=SHA1' --form 'hash=e6122b1d8abd2afbeed93fb4672af8b23a5f56b6' \\\\\n --form 'file_name=test.pdf' --form 'file_size=140939' \\\\\n --form 'archive=@test.pdf;type=application/pdf' \\\\\n --form 'archive_duration=2020-07-26T13:27:45.690' \\\\\n --form 'author_tags=préfecture,essonne'\n{\n \"document\": {\n \"type\": \"PASSEPORT\",\n \"title\": \"Passeport certifié\",\n \"file_name\": \"test.pdf\",\n \"archive_duration\": \"2020-07-26T13:27:45.690\",\n \"author_tags\": \"préfecture,essonne\",\n \"hash\": \"e6122b1d8abd2afbeed93fb4672af8b23a5f56b6\",\n \"algo\": \"SHA1\",\n \"file_size\": \"140939\",\n \"id_routage\": \"c441f90e99ca4f958131f1ed31e8fd65\"\n }\n}\n```",
"operationId": "Déposer un document certifié",
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"algo": {
"description": "Algorithme de l'empreinte ex: MD5|SHA1|SHA256|SHA512",
"type": "string"
},
"archive": {
"description": "Document à ajouter (filename+type en header, binaire en body de la part)",
"type": "string"
},
"archive_duration": {
"description": "Date de fin d'archivage légal",
"type": "string"
},
"author_tags": {
"description": "Tags émetteur (séparés par des | ou des ,)",
"type": "string"
},
"file_name": {
"description": "Nom du document (déprécié, utiliser title)",
"type": "string"
},
"file_size": {
"description": "Taille du fichier en octets",
"type": "string"
},
"hash": {
"description": "Empreinte de contrôle du document",
"type": "string"
},
"title": {
"description": "Nom du document front sans extension",
"type": "string"
},
"type": {
"description": "Nature de document, liste accessible par GET /profile/documents",
"type": "string"
}
},
"required": [
"title",
"type",
"algo",
"hash",
"file_name",
"file_size",
"archive"
],
"type": "object"
}
}
}
},
"summary": "Déposer un document certifié"
}
},
"/digiposte/v3/membership": {
"post": {
"parameters": [
{
"description": "e.g. RXu1BMRbOmkB7uT+FNj3Sijtk7mgn/MuJWVFmcfoloi0n/zLy2++V/nm6gatpQzX",
"example": "RXu1BMRbOmkB7uT+FNj3Sijtk7mgn/MuJWVFmcfoloi0n/zLy2++V/nm6gatpQzX",
"in": "header",
"name": "X-Okapi-Key",
"required": false,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/okapiKeyParameter"
}
],
"responses": {
"200": {
"content": {
"application/json; charset=utf-8": {
"examples": {
"response": {
"value": {
"accept_full_dematerialization": false,
"cancellable": true,
"dematerialized_convention_date": "2017-05-30T12:46:34Z",
"demo_account": false,
"field1_label": "Aucun",
"id": "ed249df4e1a149c9bc213bd9b4289a73",
"inbox_folder_id": "c967c5116cb14e7aa172337f368ed172",
"membership_date": "2017-05-30T12:46:34Z",
"request_date": "2017-05-30T12:46:34Z",
"sender": {
"alternative_logo": "https://static.interop.u-post.fr/share/public/images/senders/alt/OKAPI.png",
"auto_resiliation": true,
"auto_validate_expiring_membership_default": false,
"collected": false,
"contracted": false,
"contracted_creation_enabled": false,
"convention_required": false,
"convention_url": "https://api.laposte.fr",
"document_naming": "Vos Documents Dématérialisés",
"form_data": {
"field1_label": "Aucun",
"more_info": "Adhésion automatique",
"security_plus": false,
"sender_pid": "OKAPI"
},
"hr": false,
"is_multi_subscription": true,
"logo": "https://static.interop.u-post.fr/share/public/images/senders/OKAPI.png",
"mail_trust": false,
"multilingual": false,
"name": "OKAPI",
"optional_address": true,
"pid": "OKAPI",
"sender_side_convention": true,
"termination_message": "Parcours de résiliation",
"type": "SENDER",
"vip": false
},
"sender_kind": 0,
"status": "ACTIVE"
}
}
}
}
},
"description": "OK",
"headers": {}
},
"400": {
"description": "Bad Request",
"headers": {}
}
},
"security": [
{
"oauth2": []
},
{
"oauth2": []
}
],
"tags": [],
"description": "Pour faire adhérer un abonné à un nouveau flux documentaire.\n\nLe statut d'une adhésion valide est `ACTIVE`.",
"operationId": "Créer une adhésion",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {},
"properties": {},
"type": "object"
}
}
}
},
"summary": "Créer une adhésion"
}
},
"/digiposte/v3/membership/{id}": {
"delete": {
"parameters": [
{
"description": "Identifiant de l'adhésion à résilier",
"example": "ed249df4e1a149c9bc213bd9b4289a73",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. RXu1BMRbOmkB7uT+FNj3Sijtk7mgn/MuJWVFmcfoloi0n/zLy2++V/nm6gatpQzX",
"example": "RXu1BMRbOmkB7uT+FNj3Sijtk7mgn/MuJWVFmcfoloi0n/zLy2++V/nm6gatpQzX",
"in": "header",
"name": "X-Okapi-Key",
"required": false,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/okapiKeyParameter"
}
],
"responses": {
"200": {
"content": {
"application/json; charset=utf-8": {
"examples": {
"response": {
"value": {
"accept_full_dematerialization": false,
"cancellable": true,
"cancellation_date": "2017-05-30T12:50:40Z",
"dematerialized_convention_date": "2017-05-30T12:46:34Z",
"demo_account": false,
"field1_label": "Aucun",
"id": "ed249df4e1a149c9bc213bd9b4289a73",
"inbox_folder_id": "c967c5116cb14e7aa172337f368ed172",
"membership_date": "2017-05-30T12:46:34Z",
"request_date": "2017-05-30T12:46:34Z",
"sender": {
"alternative_logo": "https://static.interop.u-post.fr/share/public/images/senders/alt/OKAPI.png",
"auto_resiliation": true,
"auto_validate_expiring_membership_default": false,
"collected": false,
"contracted": false,
"contracted_creation_enabled": false,
"convention_required": false,
"convention_url": "https://api.laposte.fr",
"document_naming": "Vos Documents Dématérialisés",
"form_data": {
"field1_label": "Aucun",
"more_info": "Adhésion automatique",
"security_plus": false,
"sender_pid": "OKAPI"
},
"hr": false,
"is_multi_subscription": true,
"logo": "https://static.interop.u-post.fr/share/public/images/senders/OKAPI.png",
"mail_trust": false,
"multilingual": false,
"name": "OKAPI",
"optional_address": true,
"pid": "OKAPI",
"sender_side_convention": true,
"termination_message": "Parcours de résiliation",
"type": "SENDER",
"vip": false
},
"sender_kind": 0,
"status": "ACTIVE"
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"tags": [],
"description": "Pour mettre fin à l'adhésion entre l'abonné et l'émetteur.\n\nL'adhésion n'est pas immédiatement supprimée, mais son statut passe à `CANCEL_IN_PROGRESS`.\n\nSupprimer une adhésion, ne supprime pas les documents qui ont été déposés par cette dernière.",
"operationId": "Résilier une adhésion",
"summary": "Résilier une adhésion"
}
},
"/digiposte/v3/memberships": {
"get": {
"parameters": [
{
"description": "e.g. RXu1BMRbOmkB7uT+FNj3Sijtk7mgn/MuJWVFmcfoloi0n/zLy2++V/nm6gatpQzX",
"example": "RXu1BMRbOmkB7uT+FNj3Sijtk7mgn/MuJWVFmcfoloi0n/zLy2++V/nm6gatpQzX",
"in": "header",
"name": "X-Okapi-Key",
"required": false,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/okapiKeyParameter"
}
],
"responses": {
"200": {
"content": {
"application/json; charset=utf-8": {
"examples": {
"response": {
"value": {
"memberships": [
{
"accept_full_dematerialization": false,
"cancellable": true,
"dematerialized_convention_date": "2017-05-30T12:46:34Z",
"demo_account": false,
"field1_label": "Aucun",
"id": "ed249df4e1a149c9bc213bd9b4289a73",
"inbox_folder_id": "c967c5116cb14e7aa172337f368ed172",
"membership_date": "2017-05-30T12:46:34Z",
"request_date": "2017-05-30T12:46:34Z",
"sender": {
"alternative_logo": "https://static.interop.u-post.fr/share/public/images/senders/alt/OKAPI.png",
"auto_resiliation": true,
"auto_validate_expiring_membership_default": false,
"collected": false,
"contracted": false,
"contracted_creation_enabled": false,
"convention_required": false,
"convention_url": "https://api.laposte.fr",
"document_naming": "Vos Documents Dématérialisés",
"form_data": {
"field1_label": "Aucun",
"more_info": "Adhésion automatique",
"security_plus": false,
"sender_pid": "OKAPI"
},
"hr": false,
"is_multi_subscription": true,
"logo": "https://static.interop.u-post.fr/share/public/images/senders/OKAPI.png",
"mail_trust": false,
"multilingual": false,
"name": "OKAPI",
"optional_address": true,
"pid": "OKAPI",
"sender_side_convention": true,
"termination_message": "Parcours de résiliation",
"type": "SENDER",
"vip": false
},
"sender_kind": 0,
"status": "ACTIVE"
}
]
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"tags": [],
"description": "Pour connaitre la liste des adhésions en cours (et leur code de routage).",
"operationId": "Récupérer la liste des adhésions existantes",
"summary": "Récupérer la liste des adhésions existantes"
}
},
"/digiposte/v3/oauth/token": {
"post": {
"parameters": [
{
"description": "e.g. RXu1BMRbOmkB7uT+FNj3Sijtk7mgn/MuJWVFmcfoloi0n/zLy2++V/nm6gatpQzX",
"example": "RXu1BMRbOmkB7uT+FNj3Sijtk7mgn/MuJWVFmcfoloi0n/zLy2++V/nm6gatpQzX",
"in": "header",
"name": "X-Okapi-Key",
"required": false,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/okapiKeyParameter"
}
],
"responses": {
"200": {
"content": {
"application/json; charset=utf-8": {
"examples": {
"response": {
"value": {
"access_token": "b939b5d6-f3d1-43e4-877a-ecb46e616d40",
"expires_in": 3599,
"scope": "trust",
"token_type": "bearer"
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"basic": []
}
],
"tags": [],
"description": "Concernant le dépôt lui-même, il n'est pas nécessaire d'avoir un token d'accès relié au compte d'un abonné,\nle dépôt pouvant avoir lieu à n'importe quel moment (pas de notion de session abonné), et l'adhésion\nreprésentant alors le consentement de l'utilisateur.\n\nDans ce cas, un token en workflow oAuth standard « client_credentials » (token d'accès à l'application\nDigiposte) peut-être obtenu par cette requête de serveur à serveur.\n\n`POST /digiposte/v3/oauth/token` avec en body `grant_type=client_credentials`",
"operationId": "Obtenir un token « client_credentials »",
"summary": "Obtenir un token « client_credentials »"
}
},
"/partner/procedure/{procedure_pid}/qualify": {
"put": {
"parameters": [
{
"description": "PID de la démarche",
"in": "path",
"name": "procedure_pid",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/okapiKeyParameter"
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {}
},
"400": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"error": "invalid_parameter OR unauthorized_status",
"error_description": "No user procedure corresponding to {userProcedureId} OR Status {status} not in : {STATUS ALLOWED FOR QUALIFICATION}"
}
]
}
},
"schema": {
"items": {},
"type": "array"
}
}
},
"description": "Bad Request",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"tags": [],
"description": "",
"operationId": "Qualifier une démarche",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"refusalGround": "",
"refusedDocuments": [
{
"documentId": "",
"refusalGround": ""
}
],
"status": "STARTED"
},
"properties": {
"refusalGround": {
"description": "Cause du refus de la démarche",
"type": "string"
},
"refusedDocuments": {
"description": "Liste de documents refusés",
"type": "array"
},
"status": {
"description": "Statut de la démarche",
"enum": [
"STARTED",
"REQUESTED",
"VALIDATED",
"COMPLETED"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
}
}
},
"summary": "Qualifier une démarche"
}
},
"/partner/procedure/{user_procedure_id}/document/{document_id}": {
"get": {
"parameters": [
{
"description": "Identifiant de la démarche utilisateur",
"in": "path",
"name": "user_procedure_id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Identifiant du document à retourner",
"in": "path",
"name": "document_id",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/okapiKeyParameter"
}
],
"responses": {
"200": {
"content": {
"application/octet-stream": {
"examples": {
"response": {
"value": ""
}
}
}
},
"description": "OK",
"headers": {}
},
"400": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"error": "invalid_parameter",
"error_description": "No user procedure corresponding to {userProcedureId}."
}
]
}
},
"schema": {
"items": {},
"type": "array"
}
},
"application/octet-stream": {
"schema": {
"items": {},
"type": "array"
}
}
},
"description": "Bad Request",
"header
# --- truncated at 32 KB (87 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/la-poste-groupe/refs/heads/main/openapi/la-poste-groupe-digiposte-openapi.json