|
-
-
-
-
-
|
-
- Nous nous permettons de vous relancer car notre service instructeur n'a pas encore reçu de réponse concernant - les - - demandes de modifications de votre demande d’habilitation API Entreprise n°<%= - @authorization_request.external_id %>. - - Il nous manque ces informations pour rendre un avis. -
-- Répondez à notre instructeur depuis l'interface du formulaire - pour soumettre vos modifications et appuyez sur le bouton "Soumettre la demande" : -
-
- À bientôt 👋
-
- API Entreprise
-
- Il y a un mois, vous obteniez un accès 🔑 à l'API Entreprise dans le - cadre d'utilisation "<%= @authorization_request.intitule %>". -
-- Nous vous envoyons ce mail pour - savoir si tout va bien - . Le questionnaire suivant, vous permettra de nous transmettre - votre avis, vos besoins et vos manques : -
-
- À bientôt 👋
-
- L'équipe API Entreprise
-
-
- Votre demande d’habilitation API Entreprise n°<%= @authorization_request.external_id %> est en cours de
- traitement par notre service juridique.
-
-
- Vous devriez donc recevoir une réponse de notre part dans les prochains jours.
-
- 📝 Vous pouvez continuer à consulter et modifier votre demande à tout moment en suivant le lien suivant ➡️ - - <%= @authorization_request_datapass_url %> - -
-À bientôt 👋
-- Nous nous permettons de vous relancer car notre service instructeur n'a pas encore reçu de réponse concernant - - les modifications à apporter à votre demande de mise à jour de l'habilitation API Entreprise n°<%= - @authorization_request.external_id %>. - - Il nous manque ces informations pour rendre un avis. -
-
- À bientôt 👋
-
- API Entreprise
-
-
- Votre demande de mise à jour de l'habilitation API Entreprise n°<%= @authorization_request.external_id %> est en cours de
- traitement par notre service juridique.
-
-
- Vous devriez donc recevoir une réponse de notre part dans les prochains jours.
-
À bientôt 👋
-<%= @endpoint.description %> - - <%= icon(t("endpoint.opening.#{@endpoint.opening}.included_icon", raise: true)) rescue nil %> - <%= link_to t("endpoint.opening.#{@endpoint.opening}.included", raise: true), faq_index_path(anchor: 'qu-est-ce-que-les-api-incluses-par-defaut') rescue nil %> - + + + <%= icon(t("endpoint.opening.#{@endpoint.opening}.included_icon", raise: true)) rescue nil %> + <%= link_to t("endpoint.opening.#{@endpoint.opening}.included", raise: true), faq_index_path(anchor: 'qu-est-ce-que-les-api-incluses-par-defaut') rescue nil %> + <% if @endpoint.incoming? %>
- <% @endpoint.providers.map do |provider| %> - <%= t("providers.#{provider.name}") %> - <% end.join(' & ') %> -
+ <% provider_names = @endpoint.providers.map do |provider| %> + <%= provider.name %> + <% end %> + + <%= provider_names.join(' & ') %> +
+ <%= markdown_to_html(@endpoint.alert['description']) %> +
+Le jeton est émis avec une durée de vie de 18 mois, son expiration est programmée à cette date sauf en cas de révocation précoce. Trois mois avant l’expiration, diff --git a/app/views/api_entreprise/pages/home/_section_developers.html.erb b/app/views/api_entreprise/pages/home/_section_developers.html.erb index 350d1203e..40577c52b 100644 --- a/app/views/api_entreprise/pages/home/_section_developers.html.erb +++ b/app/views/api_entreprise/pages/home/_section_developers.html.erb @@ -46,8 +46,30 @@
|
-
-
-
-
-
|
-
- Nous nous permettons de vous relancer car notre service instructeur n'a pas encore reçu de réponse concernant - les - - demandes de modifications de votre demande d’habilitation API Particulier n°<%= - @authorization_request.external_id %>. - - Il nous manque ces informations pour rendre un avis. -
-- Répondez à notre instructeur depuis l'interface du formulaire - pour soumettre vos modifications et appuyez sur le bouton "Soumettre la demande" : -
-
- À bientôt 👋
-
- API Particulier
-
- Il y a un mois, vous obteniez un accès 🔑 à l'API Particulier dans le - cadre d'utilisation "<%= @authorization_request.intitule %>". -
-- Nous vous envoyons ce mail pour - savoir si tout va bien - . Le questionnaire suivant, vous permettra de nous transmettre - votre avis, vos besoins et vos manques : -
-
- À bientôt 👋
-
- L'équipe API Particulier
-
-
- Votre demande d’habilitation API Particulier n°<%= @authorization_request.external_id %> est en cours de
- traitement par notre service juridique.
-
-
- Vous devriez donc recevoir une réponse de notre part dans les prochains jours.
-
- 📝 Vous pouvez continuer à consulter et modifier votre demande à tout moment en suivant le lien suivant ➡️ - - <%= @authorization_request_datapass_url %> - -
-À bientôt 👋
-- Nous nous permettons de vous relancer car notre service instructeur n'a pas encore reçu de réponse concernant - - les modifications à apporter à votre demande de mise à jour de l'habilitation API Particulier n°<%= - @authorization_request.external_id %>. - - Il nous manque ces informations pour rendre un avis. -
-
- À bientôt 👋
-
- API Particulier
-
-
- Votre demande de mise à jour de l'habilitation API Particulier n°<%= @authorization_request.external_id %> est en cours de
- traitement par notre service juridique.
-
-
- Vous devriez donc recevoir une réponse de notre part dans les prochains jours.
-
À bientôt 👋
-- <% @endpoint.providers.map do |provider| %> - <%= t("providers.#{provider.name}") %> - <% end.join(' & ') %> -
+ <% provider_names = @endpoint.providers.map do |provider| %> + <%= provider.name %> + <% end %> + + <%= provider_names.join(' & ') %> +
+ <%= markdown_to_html(@endpoint.alert['description']) %> +
+diff --git a/app/views/api_particulier/faq/index.html.erb b/app/views/api_particulier/faq/index.html.erb index 57986af78..53c79d023 100644 --- a/app/views/api_particulier/faq/index.html.erb +++ b/app/views/api_particulier/faq/index.html.erb @@ -1,4 +1,4 @@ -
+ La liste des habilitations ci-dessous concernent les groupes de données suivants : + +
- <% if action_name == 'developers'%> - <%= t('.banner.tech', date: OpenBureauDate.new.next_date.strftime('%d/%m/%Y')).html_safe %> - <% else %> - <%= t('.banner.default', date: OpenBureauDate.new.next_date.strftime('%d/%m/%Y')).html_safe %> - <% end %> -
+ <% if Date.today >= Date.new(2024, 8, 21) %> ++ <% if action_name == 'developers'%> + <%= t('.banner.tech', date: OpenBureauDate.new.next_date.strftime('%d/%m/%Y')).html_safe %> + <% else %> + <%= t('.banner.default', date: OpenBureauDate.new.next_date.strftime('%d/%m/%Y')).html_safe %> + <% end %> +
+- <%= t('.description', api_name: api_name).html_safe %> -
++ <%= t('.description', api_name: api_name).html_safe %> +
++ <%= t('.description', api_name: api_name).html_safe %> +
+- - Qu’est-ce que MonComptePro ? + + Qu’est-ce que ProConnect ?
<% end %> diff --git a/app/views/shared/tokens/_detail.html.erb b/app/views/shared/tokens/_detail.html.erb index 1ffafdff0..516de4c52 100644 --- a/app/views/shared/tokens/_detail.html.erb +++ b/app/views/shared/tokens/_detail.html.erb @@ -3,25 +3,22 @@"> <%= t(".status.label.#{token.status}") %>
- - idenfitiant: <%= token.id %> - | <%= t('.call_for_a_week', count: token.access_logs.since(7.days.ago).count) %> <%= link_to t('.links.stats'), token_stats_path(token), id: dom_id(token, :stats_link), class: %w(fr-link fr-link--sm fr-icon-arrow-right-line fr-link--icon-right pull-right) %>- <%= t(".remaining_time.#{token.status}", + <%= t(".remaining_time.#{token.status}", remaining_time: distance_of_time_in_words(Time.zone.now, token.end_timestamp) ).html_safe %>
"> <%= t(".status.label.#{token.status}") %> -
+ - | <%= t(".expiration_date", + | <%= t(".expiration_date", expiration_date: friendly_date_from_timestamp(token.end_timestamp) ).html_safe %> -- ID: <%= token.id %> -
<%= t('.description', link_to_datapass: link_to( - t('shared.links.to_datapass', external_id: @token.authorization_request.external_id).html_safe, - datapass_authorization_request_url(@token.authorization_request), + t('shared.links.to_datapass', external_id: @token.authorization_request.external_id).html_safe, + datapass_authorization_request_url(@token.authorization_request), id: :authorization_request_link, - class: %w(fr-link), + class: %w(fr-link), target: '_blank'), remaining_time: distance_of_time_in_words(Time.zone.now, @token.end_timestamp) ).html_safe %> diff --git a/app/views/shared/transfer_user_account/_new.html.erb b/app/views/shared/transfer_user_account/_new.html.erb deleted file mode 100644 index 917c1b2ab..000000000 --- a/app/views/shared/transfer_user_account/_new.html.erb +++ /dev/null @@ -1,25 +0,0 @@ -<%= form_with url: transfer_account_path, method: :post, id: :transfer_account_form, data: { turbo_frame: '_top' } do |form| %> -
<%= t('.description', api: t("#{namespace}.api")).html_safe %>
- -- <%= t('.transfer_account.description_if_demandeur').html_safe %> -
- - - <%= t('.transfer_account.cta') %> - -- <%= t('.transfer_account.description_if_demandeur_transfer_not_all', api: t("#{namespace}.api")).html_safe %> + <%= t('.transfer_account.description_if_demandeur', api: namespace.gsub('_', '-')).html_safe %>
diff --git a/bin/download_latest_open_api_definitions.sh b/bin/download_latest_open_api_definitions.sh index f81955169..99b4c2fcd 100755 --- a/bin/download_latest_open_api_definitions.sh +++ b/bin/download_latest_open_api_definitions.sh @@ -3,5 +3,8 @@ wget "https://particulier.api.gouv.fr/api/open-api.yml" \ -O config/api-particulier-openapi.yml +wget "https://particulier.api.gouv.fr/api/open-api-v3.yml" \ + -O config/api-particulier-openapi-v3.yml + wget "https://entreprise.api.gouv.fr/v3/openapi-entreprise.yaml" \ -O config/api-entreprise-v3-openapi.yml diff --git a/config/api-entreprise-v3-openapi.yml b/config/api-entreprise-v3-openapi.yml index 5308411ff..e7c420912 100644 --- a/config/api-entreprise-v3-openapi.yml +++ b/config/api-entreprise-v3-openapi.yml @@ -9,7 +9,7 @@ info: d'une clé d'accès (jeton).\n\n### Comment tester l'API ?\n\nIl est possible de tester les API via notre environnement de **staging** qui vous retournera systématiquement des données fictives. Référez vous à la [documentation](https://entreprise.api.gouv.fr/developpeurs#tester-api-preproduction).\n\nIl - est nécessaire d'utiliser le jeton de staging indiqué ci-dessous.\n\n---\n\n*eyJhbGciOiJIUzI1NiJ9.eyJ1aWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJqdGkiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJzY29wZXMiOlsidXB0aW1lIiwiYXNzb2NpYXRpb25zIiwib3Blbl9kYXRhIiwiYXR0ZXN0YXRpb25zX2FnZWZpcGgiLCJwcm9idHAiLCJjb3Rpc2F0aW9uc19wcm9idHAiLCJhdHRlc3RhdGlvbnNfZmlzY2FsZXMiLCJhdHRlc3RhdGlvbl9maXNjYWxlX2RnZmlwIiwiYXR0ZXN0YXRpb25zX3NvY2lhbGVzIiwiYXR0ZXN0YXRpb25fc29jaWFsZV91cnNzYWYiLCJiaWxhbnNfZW50cmVwcmlzZV9iZGYiLCJiaWxhbnNfYmRmIiwiZm50cF9jYXJ0ZV9wcm8iLCJjZXJ0aWZpY2F0X2NuZXRwIiwiY2VydGlmaWNhdGlvbl9jbmV0cCIsImNlcnRpZmljYXRfb3BxaWJpIiwicXVhbGliYXQiLCJjZXJ0aWZpY2F0X3JnZV9hZGVtZSIsImRvY3VtZW50c19hc3NvY2lhdGlvbiIsImVudHJlcHJpc2VzIiwidW5pdGVzX2xlZ2FsZXNfZXRhYmxpc3NlbWVudHNfaW5zZWUiLCJldGFibGlzc2VtZW50cyIsImV4ZXJjaWNlcyIsImNoaWZmcmVfYWZmYWlyZXNfZGdmaXAiLCJleHRyYWl0c19yY3MiLCJsaWFzc2VfZmlzY2FsZSIsImxpYXNzZXNfZmlzY2FsZXNfZGdmaXAiLCJjZXJ0aWZpY2F0aW9uc19xdWFsaW9waV9mcmFuY2VfY29tcGV0ZW5jZXMiLCJlb3JpX2RvdWFuZXMiLCJjb252ZW50aW9uc19jb2xsZWN0aXZlcyIsIm1hbmRhdGFpcmVzX3NvY2lhdXhfaW5mb2dyZWZmZSIsImFjdGVzX2lucGkiLCJleHRyYWl0X2NvdXJ0X2lucGkiLCJhc3NvY2lhdGlvbnNfZG9ubmVlc19wcm90ZWdlZXMiLCJhc3NvY2lhdGlvbnNfZGplcHZhIiwibXNhX2NvdGlzYXRpb25zIiwiY290aXNhdGlvbnNfbXNhIiwiY2VydGlmaWNhdGlvbl9vcHFpYmkiLCJlbnRyZXByaXNlc19hcnRpc2FuYWxlcyIsImVmZmVjdGlmc191cnNzYWYiLCJjbmFmX3F1b3RpZW50X2ZhbWlsaWFsIiwiY25hZl9hbGxvY2F0YWlyZXMiLCJjbmFmX2VuZmFudHMiLCJjbmFmX2FkcmVzc2UiLCJjb21wbGVtZW50YWlyZV9zYW50ZV9zb2xpZGFpcmUiLCJjbm91c19zdGF0dXRfYm91cnNpZXIiLCJjbm91c19lY2hlbG9uX2JvdXJzZSIsImNub3VzX2VtYWlsIiwiY25vdXNfcGVyaW9kZV92ZXJzZW1lbnQiLCJjbm91c19zdGF0dXRfYm91cnNlIiwiY25vdXNfdmlsbGVfZXR1ZGVzIiwiY25vdXNfaWRlbnRpdGUiLCJkZ2ZpcF9kZWNsYXJhbnQxX25vbSIsImRnZmlwX2RlY2xhcmFudDFfbm9tX25haXNzYW5jZSIsImRnZmlwX2RlY2xhcmFudDFfcHJlbm9tcyIsImRnZmlwX2RlY2xhcmFudDFfZGF0ZV9uYWlzc2FuY2UiLCJkZ2ZpcF9kZWNsYXJhbnQyX25vbSIsImRnZmlwX2RlY2xhcmFudDJfbm9tX25haXNzYW5jZSIsImRnZmlwX2RlY2xhcmFudDJfcHJlbm9tcyIsImRnZmlwX2RlY2xhcmFudDJfZGF0ZV9uYWlzc2FuY2UiLCJkZ2ZpcF9kYXRlX3JlY291dnJlbWVudCIsImRnZmlwX2RhdGVfZXRhYmxpc3NlbWVudCIsImRnZmlwX2FkcmVzc2VfZmlzY2FsZV90YXhhdGlvbiIsImRnZmlwX2FkcmVzc2VfZmlzY2FsZV9hbm5lZSIsImRnZmlwX25vbWJyZV9wYXJ0cyIsImRnZmlwX25vbWJyZV9wZXJzb25uZXNfYV9jaGFyZ2UiLCJkZ2ZpcF9zaXR1YXRpb25fZmFtaWxpYWxlIiwiZGdmaXBfcmV2ZW51X2JydXRfZ2xvYmFsIiwiZGdmaXBfcmV2ZW51X2ltcG9zYWJsZSIsImRnZmlwX2ltcG90X3JldmVudV9uZXRfYXZhbnRfY29ycmVjdGlvbnMiLCJkZ2ZpcF9tb250YW50X2ltcG90IiwiZGdmaXBfcmV2ZW51X2Zpc2NhbF9yZWZlcmVuY2UiLCJkZ2ZpcF9hbm5lZV9pbXBvdCIsImRnZmlwX2FubmVlX3JldmVudXMiLCJkZ2ZpcF9lcnJldXJfY29ycmVjdGlmIiwiZGdmaXBfc2l0dWF0aW9uX3BhcnRpZWxsZSIsIm1lc3JpX2lkZW50aWZpYW50IiwibWVzcmlfaWRlbnRpdGUiLCJtZXNyaV9pbnNjcmlwdGlvbl9ldHVkaWFudCIsIm1lc3JpX2luc2NyaXB0aW9uX2F1dHJlIiwibWVzcmlfYWRtaXNzaW9uIiwibWVzcmlfZXRhYmxpc3NlbWVudHMiLCJwb2xlX2VtcGxvaV9pZGVudGl0ZSIsInBvbGVfZW1wbG9pX2FkcmVzc2UiLCJwb2xlX2VtcGxvaV9jb250YWN0IiwicG9sZV9lbXBsb2lfaW5zY3JpcHRpb24iLCJwb2xlX2VtcGxvaV9wYWllbWVudHMiLCJtZW5fc3RhdHV0X3Njb2xhcml0ZSIsIm1lbl9zdGF0dXRfYm91cnNpZXIiLCJtZW5fZWNoZWxvbl9ib3Vyc2UiXSwic3ViIjoic3RhZ2luZyBkZXZlbG9wbWVudCIsImlhdCI6MTY5MzkwNTAyNCwidmVyc2lvbiI6IjEuMCIsImV4cCI6MjAwOTUyNDIyNH0.uKkMeXNmzwaultKAuS6l1o9StrZky-mY7XLTzygdut4*\n + est nécessaire d'utiliser le jeton de staging indiqué ci-dessous.\n\n---\n\n*eyJhbGciOiJIUzI1NiJ9.eyJ1aWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJqdGkiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJzY29wZXMiOlsiYXNzb2NpYXRpb25zIiwib3Blbl9kYXRhIiwicHJvYnRwIiwiY290aXNhdGlvbnNfcHJvYnRwIiwiYXR0ZXN0YXRpb25zX2Zpc2NhbGVzIiwiYXR0ZXN0YXRpb25fZmlzY2FsZV9kZ2ZpcCIsImF0dGVzdGF0aW9uc19zb2NpYWxlcyIsImF0dGVzdGF0aW9uX3NvY2lhbGVfdXJzc2FmIiwiYmlsYW5zX2VudHJlcHJpc2VfYmRmIiwiYmlsYW5zX2JkZiIsImZudHBfY2FydGVfcHJvIiwiY2VydGlmaWNhdF9jbmV0cCIsImNlcnRpZmljYXRpb25fY25ldHAiLCJjZXJ0aWZpY2F0X29wcWliaSIsInF1YWxpYmF0IiwiY2VydGlmaWNhdF9yZ2VfYWRlbWUiLCJkb2N1bWVudHNfYXNzb2NpYXRpb24iLCJlbnRyZXByaXNlcyIsInVuaXRlc19sZWdhbGVzX2V0YWJsaXNzZW1lbnRzX2luc2VlIiwiZXRhYmxpc3NlbWVudHMiLCJleGVyY2ljZXMiLCJjaGlmZnJlX2FmZmFpcmVzX2RnZmlwIiwiZXh0cmFpdHNfcmNzIiwibGlhc3NlX2Zpc2NhbGUiLCJsaWFzc2VzX2Zpc2NhbGVzX2RnZmlwIiwiY2VydGlmaWNhdGlvbnNfcXVhbGlvcGlfZnJhbmNlX2NvbXBldGVuY2VzIiwiZW9yaV9kb3VhbmVzIiwiY29udmVudGlvbnNfY29sbGVjdGl2ZXMiLCJtYW5kYXRhaXJlc19zb2NpYXV4X2luZm9ncmVmZmUiLCJhY3Rlc19pbnBpIiwiZXh0cmFpdF9jb3VydF9pbnBpIiwiYXNzb2NpYXRpb25zX2Rvbm5lZXNfcHJvdGVnZWVzIiwiYXNzb2NpYXRpb25zX2RqZXB2YSIsIm1zYV9jb3Rpc2F0aW9ucyIsImNvdGlzYXRpb25zX21zYSIsImNlcnRpZmljYXRpb25fb3BxaWJpIiwiZW50cmVwcmlzZXNfYXJ0aXNhbmFsZXMiLCJlZmZlY3RpZnNfdXJzc2FmIiwiY25hZl9xdW90aWVudF9mYW1pbGlhbCIsImNuYWZfYWxsb2NhdGFpcmVzIiwiY25hZl9lbmZhbnRzIiwiY25hZl9hZHJlc3NlIiwiY29tcGxlbWVudGFpcmVfc2FudGVfc29saWRhaXJlIiwiYWxsb2NhdGlvbl9hZHVsdGVfaGFuZGljYXBlIiwicmV2ZW51X3NvbGlkYXJpdGVfYWN0aXZlIiwicmV2ZW51X3NvbGlkYXJpdGVfYWN0aXZlX21ham9yYXRpb24iLCJhbGxvY2F0aW9uX3NvdXRpZW5fZmFtaWxpYWwiLCJwcmltZV9hY3Rpdml0ZSIsInByaW1lX2FjdGl2aXRlX21ham9yYXRpb24iLCJjbm91c19zdGF0dXRfYm91cnNpZXIiLCJjbm91c19lY2hlbG9uX2JvdXJzZSIsImNub3VzX2VtYWlsIiwiY25vdXNfcGVyaW9kZV92ZXJzZW1lbnQiLCJjbm91c19zdGF0dXRfYm91cnNlIiwiY25vdXNfdmlsbGVfZXR1ZGVzIiwiY25vdXNfaWRlbnRpdGUiLCJtZXNyaV9pZGVudGlmaWFudCIsIm1lc3JpX2lkZW50aXRlIiwibWVzcmlfaW5zY3JpcHRpb25fZXR1ZGlhbnQiLCJtZXNyaV9pbnNjcmlwdGlvbl9hdXRyZSIsIm1lc3JpX2FkbWlzc2lvbiIsIm1lc3JpX2V0YWJsaXNzZW1lbnRzIiwicG9sZV9lbXBsb2lfaWRlbnRpdGUiLCJwb2xlX2VtcGxvaV9hZHJlc3NlIiwicG9sZV9lbXBsb2lfY29udGFjdCIsInBvbGVfZW1wbG9pX2luc2NyaXB0aW9uIiwicG9sZV9lbXBsb2lfcGFpZW1lbnRzIiwibWVuX3N0YXR1dF9zY29sYXJpdGUiLCJtZW5fc3RhdHV0X2JvdXJzaWVyIiwibWVuX2VjaGVsb25fYm91cnNlIl0sInN1YiI6InN0YWdpbmcgZGV2ZWxvcG1lbnQiLCJpYXQiOjE3MTk0ODAzNDIsInZlcnNpb24iOiIxLjAiLCJleHAiOjIwMzUwMTMxNDJ9.3amltSm0dQ_1mvhAvS5E2Qv6Q6HaF_oEHhNck1MLDSk*\n \ " termsOfService: https://entreprise.api.gouv.fr/cgu/ contact: @@ -49,35 +49,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -145,23 +127,23 @@ paths: de données. schema: type: string - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -198,35 +180,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -342,7 +306,7 @@ paths: example: 7889238 description: 'Nombre de secondes avant l''expiration de l''url associée à l''attribut document_url : cette durée correspond - généralement à 3 mois.' + généralement à 24h.' required: - document_url - expires_in @@ -410,7 +374,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '04999' @@ -533,6 +497,23 @@ paths: description: Entreprise non trouvée content: application/json: + examples: + entite_non_trouvee_04003: + value: + errors: + - code: '04003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: ACOSS + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '504': @@ -607,23 +588,23 @@ paths: tags: - Certifications professionnelles parameters: - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -680,8 +661,8 @@ paths: type: number security: - jwt_bearer_token: [] - description: Certifications RGE (Reconnu Garant de l'Environnement), d'un établissement, - délivrée par l'Ademe. + description: Certifications RGE (Reconnu Garant de l'Environnement) d'un établissement, + délivrées par l'Ademe. responses: '401': description: Non autorisé @@ -699,35 +680,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -1059,6 +1022,23 @@ paths: description: Non trouvée content: application/json: + examples: + entite_non_trouvee_19003: + value: + errors: + - code: '19003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: ADEME + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '502': @@ -1066,7 +1046,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '19999' @@ -1155,23 +1135,23 @@ paths: tags: - Informations financières parameters: - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -1218,35 +1198,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -1721,6 +1683,23 @@ paths: description: Non trouvée content: application/json: + examples: + entite_non_trouvee_17003: + value: + errors: + - code: '17003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: Banque de France + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '502': @@ -1728,7 +1707,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '17999' @@ -1851,23 +1830,23 @@ paths: required: true schema: type: string - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -1902,35 +1881,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -2055,13 +2016,9 @@ paths: actif: title: Indique que le NDA est actif description: Ce champ indique le numéro de déclaration - d'activité (NDA) de l'établissement est actif. Pour - conserver un NDA valide, l'établissement doit remplir - chaque année un bilan pédagogique et financier prévu - à l'article L6352-11 du Code du travail. Sans cette - démarche le numéro NDA devient inactif, l'établissement - est retiré de la liste publique des organismes de - formation. + d'activité (NDA) de l'établissement est actif. Cette + valeur est toujours égale à 'true' et est conservée + pour des raisons de retrocompatibilité type: boolean example: true date_derniere_declaration: @@ -2354,6 +2311,23 @@ paths: description: Non trouvée content: application/json: + examples: + entite_non_trouvee_33003: + value: + errors: + - code: '33003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: CARIF-OREF + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '502': @@ -2361,7 +2335,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '33999' @@ -2444,29 +2418,29 @@ paths: curl -X GET \ -H "Authorization: Bearer $token" \ --url "https://entreprise.api.gouv.fr/v3/carif_oref/etablissements/13002526500013/certifications_qualiopi_france_competences?context=Test+de+l%27API&object=Test+de+l%27API&recipient=10000001700010" - "/v3/cnetp/unites_legales/{siren}/attestation_cotisations_conges_payes_chomage_intemperies": + "/v3/cibtp/etablissements/{siret}/attestation_cotisations_conges_payes_chomage_intemperies": get: - summary: Attestation de cotisations congés payés & chômage-intempéries + summary: Certificat cotisations CIBTP tags: - Attestations sociales et fiscales parameters: - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -2480,16 +2454,16 @@ paths: required: true schema: type: string - - name: siren + - name: siret in: path required: true schema: type: string security: - jwt_bearer_token: [] - description: Attestation de cotisations, délivrée par la Caisse nationale des - entrepreneurs de travaux publics (CNETP), attestant le respect des obligations - relatives aux congés payés et au chômage-intempéries. + description: Certificat indiquant qu'une entreprise du bâtiment, affiliée à + la majorité des caisses du réseau CIBTP France, est en règle de ses cotisations + congés payés et chômage-intempéries. responses: '401': description: Non autorisé @@ -2507,35 +2481,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -2591,7 +2547,7 @@ paths: schema: "$ref": "#/components/schemas/Error" '200': - description: Certificat trouvé + description: Entreprise trouvée headers: RateLimit-Limit: schema: @@ -2610,7 +2566,7 @@ paths: type: integer description: La fin de la période courante (en format timestamp) example: 1637223155 - x-operationId: api_entreprise_v3_cnetp_attestation_cotisations_conges_payes_chomage_intemperies + x-operationId: api_entreprise_v3_cibtp_attestation_cotisations_conges_payes_chomage_intemperies content: application/json: schema: @@ -2620,20 +2576,25 @@ paths: type: object properties: document_url: + title: Lien vers le certificat CIBTP type: string - title: Lien vers l'attestation de cotisation retraite ProBTP - description: Ce document est automatiquement supprimé au bout - de 3 mois. - example: https://storage.entreprise.api.gouv.fr/siade/1569139162-b99824d9c764aae19a862a0af-attestation_cotisation_retraite_probtp.pdf + nullable: true + description: Ce lien délivre l'attestation au format PDF. + Ce document est automatiquement supprimé après 10 minutes. + example: https://storage.entreprise.api.gouv.fr/siade/1569139162-b99824d9c764aae19a862a0af-certificat_cibtp.pdf expires_in: + title: Expiration du lien + description: Nombre de secondes avant expiration du document + référencé dans 'document_url'. Il s'agit d'une expiration + technique. Ce champ n'est pas une date de fin de validité + de l'attestation type: integer - example: 7889238 - description: 'Nombre de secondes avant l''expiration de l''url - associée à l''attribut document_url : cette durée correspond - généralement à 3 mois.' + nullable: true + example: 600 required: - document_url - expires_in + additionalProperties: false links: type: object meta: @@ -2647,17 +2608,17 @@ paths: content: application/json: examples: - unprocessable_entity_error_siren_error: + unprocessable_entity_error_siret_error: value: errors: - - code: '00301' + - code: '00302' title: Entité non traitable - detail: Le numéro de siren n'est pas correctement formatté + detail: Le numéro de siret n'est pas correctement formatté source: - parameter: siren + parameter: siret meta: {} summary: Entité non traitable - description: Le numéro de siren n'est pas correctement formatté + description: Le numéro de siret n'est pas correctement formatté missing_mandatory_params_context_error: value: errors: @@ -2697,82 +2658,58 @@ paths: description: Erreur du fournisseur content: application/json: + schema: + "$ref": "#/components/schemas/Error" examples: - unknown_error: + provider_unknown_error: value: errors: - - code: '08999' + - code: '38999' title: Erreur inconnue du fournisseur de données detail: La réponse retournée par le fournisseur de données est invalide et inconnue de notre service. L'équipe technique a été notifiée de cette erreur pour investigation. source: meta: - provider: CNETP + provider: CIBTP summary: Erreur inconnue du fournisseur de données description: La réponse retournée par le fournisseur de données est invalide et inconnue de notre service. L'équipe technique a été notifiée de cette erreur pour investigation. - fichier_renvoye_par_le_fournisseur_de_donnees_non_valide_08051: - value: - errors: - - code: '08051' - title: Fichier renvoyé par le fournisseur de données non valide - detail: 'Erreur lors du décodage : la chaîne de caractères en - base64 est invalide' - source: - meta: {} - summary: Fichier renvoyé par le fournisseur de données non valide - description: 'Erreur lors du décodage : la chaîne de caractères - en base64 est invalide' - fichier_renvoye_par_le_fournisseur_de_donnees_non_valide_08052: - value: - errors: - - code: '08052' - title: Fichier renvoyé par le fournisseur de données non valide - detail: Temps d'attente de téléchargement du document écoulé - source: - meta: {} - summary: Fichier renvoyé par le fournisseur de données non valide - description: Temps d'attente de téléchargement du document écoulé - fichier_renvoye_par_le_fournisseur_de_donnees_non_valide_08053: - value: - errors: - - code: '08053' - title: Fichier renvoyé par le fournisseur de données non valide - detail: Erreur de connexion sur le server distant - source: - meta: {} - summary: Fichier renvoyé par le fournisseur de données non valide - description: Erreur de connexion sur le server distant - fichier_renvoye_par_le_fournisseur_de_donnees_non_valide_08054: + '404': + description: Non trouvée + content: + application/json: + examples: + attestation_non_disponible_38422: value: errors: - - code: '08054' - title: Fichier renvoyé par le fournisseur de données non valide - detail: L'URL vers le document renvoyée par le fournisseur de - données est invalide + - code: '38422' + title: Attestation non disponible + detail: L'attestation ne peut être délivrée car l'entreprise + n'est pas en règle de ses cotisations CIBTP. source: - meta: {} - summary: Fichier renvoyé par le fournisseur de données non valide - description: L'URL vers le document renvoyée par le fournisseur - de données est invalide - fichier_renvoye_par_le_fournisseur_de_donnees_non_valide_08055: + meta: + provider: CIBTP + summary: Attestation non disponible + description: L'attestation ne peut être délivrée car l'entreprise + n'est pas en règle de ses cotisations CIBTP. + entite_non_trouvee_38003: value: errors: - - code: '08055' - title: Fichier renvoyé par le fournisseur de données non valide - detail: Le fichier n'est pas au format attendu + - code: '38003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. source: - meta: {} - summary: Fichier renvoyé par le fournisseur de données non valide - description: Le fichier n'est pas au format attendu - schema: - "$ref": "#/components/schemas/Error" - '404': - description: Non trouvé - content: - application/json: + meta: + provider: CIBTP + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '504': @@ -2783,26 +2720,26 @@ paths: timeout_error: value: errors: - - code: '08002' + - code: '38002' title: Intermédiaire hors-délai detail: Temps d’attente d’une réponse du fournisseur de données écoulé. source: meta: - provider: CNETP + provider: CIBTP summary: Intermédiaire hors-délai description: Temps d’attente d’une réponse du fournisseur de données écoulé. provider_unavailable_error: value: errors: - - code: '08001' + - code: '38001' title: Service non disponible detail: Service du fournisseur de données temporairement indisponible ou en maintenance. source: meta: - provider: CNETP + provider: CIBTP summary: Service non disponible description: Service du fournisseur de données temporairement indisponible ou en maintenance. @@ -2824,48 +2761,39 @@ paths: dns_resolution_error: value: errors: - - code: '08004' + - code: '38004' title: Erreur de résolution DNS detail: Problème de résolution DNS de l'adresse du serveur source: meta: - provider: CNETP + provider: CIBTP summary: Erreur de résolution DNS description: Problème de résolution DNS de l'adresse du serveur schema: "$ref": "#/components/schemas/Error" - x-maintenances: - from_hour: '06:00' - to_hour: '06:30' x-codeSamples: - lang: cURL label: Ligne de commande source: |- curl -X GET \ -H "Authorization: Bearer $token" \ - --url "https://entreprise.api.gouv.fr/v3/cnetp/unites_legales/130025265/attestation_cotisations_conges_payes_chomage_intemperies?context=Test+de+l%27API&object=Test+de+l%27API&recipient=10000001700010" - "/v3/douanes/etablissements/{siret_or_eori}/immatriculations_eori": + --url "https://entreprise.api.gouv.fr/v3/cibtp/etablissements/13002526500013/attestation_cotisations_conges_payes_chomage_intemperies?context=Test+de+l%27API&object=Test+de+l%27API&recipient=10000001700010" + "/v3/cnetp/unites_legales/{siren}/attestation_cotisations_conges_payes_chomage_intemperies": get: - summary: Immatriculation EORI + summary: Certificat cotisations CNETP tags: - - Informations générales + - Attestations sociales et fiscales parameters: - - name: siret_or_eori - in: path - description: Siret ou numéro EORI de l'entreprise - examples: - french_siret: - value: '16002307300010' - summary: Siret français - french_eori: - value: FR16002307300010 - summary: Numéro EORI français - spanish_eori: - value: ESA08536583 - summary: Numéro EORI espagnol - required: true - schema: - type: string + - name: recipient + in: query + description: |- + "**Bénéficiaire de l’appel** + + SIRET de l’administration destinatrice des données." + example: '13002526500013' + required: true + schema: + type: string - name: context in: query description: |- @@ -2876,6 +2804,400 @@ paths: required: true schema: type: string + - name: object + in: query + description: |- + "**La raison de l’appel ou l’identifiant de la procédure.** + + L’identifiant peut être interne à votre organisation ou bien un numéro de marché publique, un nom de procédure ; l’essentiel est que celui-ci vous permette de tracer et de retrouver les informations relatives à l’appel. En effet, vous devez pouvoir justifier de la raison d’un appel auprès du fournisseur de données. Description courte ( < 50 caractères )." + example: marché numéro 127 + required: true + schema: + type: string + - name: siren + in: path + required: true + schema: + type: string + security: + - jwt_bearer_token: [] + description: Certificat indiquant qu'une entreprise de travaux publics affiliée + à la caisse CNETP est en règle de ses cotisations congés payés et chômage-intempéries. + responses: + '401': + description: Non autorisé + content: + application/json: + examples: + invalid_token_error: + value: + errors: + - code: '00101' + title: Interdit + detail: Votre token n'est pas valide ou n'est pas renseigné + source: + parameter: token + meta: {} + summary: Interdit + description: Votre token n'est pas valide ou n'est pas renseigné + expired_token_error: + value: + errors: + - code: '00103' + title: Jeton expiré + detail: Votre token est expiré. Vous devez refaire une demande + source: + parameter: token + meta: {} + summary: Jeton expiré + description: Votre token est expiré. Vous devez refaire une demande + blacklisted_token_error: + value: + errors: + - code: '00105' + title: Jeton sur liste noire + detail: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver + un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + source: + parameter: token + meta: {} + summary: Jeton sur liste noire + description: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver un + jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + schema: + "$ref": "#/components/schemas/Error" + '403': + description: Accès interdit + content: + application/json: + examples: + insufficient_privileges_error: + value: + errors: + - code: '00100' + title: Privilèges insuffisants + detail: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /v2/privileges + source: + parameter: token + meta: {} + summary: Privilèges insuffisants + description: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /v2/privileges + schema: + "$ref": "#/components/schemas/Error" + '429': + description: Trop de requêtes + content: + application/json: + examples: + too_many_requests_error: + value: + errors: + - code: '00429' + title: Trop de requêtes + detail: Vous avez effectué trop de requêtes + source: + meta: {} + summary: Trop de requêtes + description: Vous avez effectué trop de requêtes + schema: + "$ref": "#/components/schemas/Error" + '200': + description: Certificat trouvé + headers: + RateLimit-Limit: + schema: + type: integer + description: La limite concernant l’endpoint appelé, soit le nombre + de requête/minute. + example: 50 + RateLimit-Remaining: + schema: + type: integer + description: Le nombre d’appels restants durant la période courante + d’une minute. + example: 47 + RateLimit-Reset: + schema: + type: integer + description: La fin de la période courante (en format timestamp) + example: 1637223155 + x-operationId: api_entreprise_v3_cnetp_attestation_cotisations_conges_payes_chomage_intemperies + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + document_url: + type: string + title: Lien vers le certificat CNETP + description: Ce lien délivre l'attestation au format PDF. + Ce document est automatiquement supprimé après 24h. + example: https://storage.entreprise.api.gouv.fr/siade/1569139162-b99824d9c764aae19a862a0af-certificat_cnetp.pdf + expires_in: + type: integer + example: 7889238 + description: 'Nombre de secondes avant l''expiration de l''url + associée à l''attribut document_url : cette durée correspond + généralement à 24h.' + required: + - document_url + - expires_in + links: + type: object + meta: + type: object + required: + - data + - links + - meta + '422': + description: Paramètre(s) invalide(s) + content: + application/json: + examples: + unprocessable_entity_error_siren_error: + value: + errors: + - code: '00301' + title: Entité non traitable + detail: Le numéro de siren n'est pas correctement formatté + source: + parameter: siren + meta: {} + summary: Entité non traitable + description: Le numéro de siren n'est pas correctement formatté + missing_mandatory_params_context_error: + value: + errors: + - code: '00201' + title: Entité non traitable + detail: Le paramètre context est obligatoire + source: + parameter: context + meta: {} + summary: Entité non traitable + description: Le paramètre context est obligatoire + missing_mandatory_params_object_error: + value: + errors: + - code: '00202' + title: Entité non traitable + detail: Le paramètre object est obligatoire + source: + parameter: object + meta: {} + summary: Entité non traitable + description: Le paramètre object est obligatoire + missing_mandatory_params_recipient_error: + value: + errors: + - code: '00203' + title: Entité non traitable + detail: Le paramètre recipient est obligatoire + source: + parameter: recipient + meta: {} + summary: Entité non traitable + description: Le paramètre recipient est obligatoire + schema: + "$ref": "#/components/schemas/Error" + '502': + description: Erreur du fournisseur + content: + application/json: + examples: + provider_unknown_error: + value: + errors: + - code: '08999' + title: Erreur inconnue du fournisseur de données + detail: La réponse retournée par le fournisseur de données est + invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + source: + meta: + provider: CNETP + summary: Erreur inconnue du fournisseur de données + description: La réponse retournée par le fournisseur de données + est invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + fichier_renvoye_par_le_fournisseur_de_donnees_non_valide_08051: + value: + errors: + - code: '08051' + title: Fichier renvoyé par le fournisseur de données non valide + detail: 'Erreur lors du décodage : la chaîne de caractères en + base64 est invalide' + source: + meta: {} + summary: Fichier renvoyé par le fournisseur de données non valide + description: 'Erreur lors du décodage : la chaîne de caractères + en base64 est invalide' + fichier_renvoye_par_le_fournisseur_de_donnees_non_valide_08052: + value: + errors: + - code: '08052' + title: Fichier renvoyé par le fournisseur de données non valide + detail: Temps d'attente de téléchargement du document écoulé + source: + meta: {} + summary: Fichier renvoyé par le fournisseur de données non valide + description: Temps d'attente de téléchargement du document écoulé + fichier_renvoye_par_le_fournisseur_de_donnees_non_valide_08053: + value: + errors: + - code: '08053' + title: Fichier renvoyé par le fournisseur de données non valide + detail: Erreur de connexion sur le server distant + source: + meta: {} + summary: Fichier renvoyé par le fournisseur de données non valide + description: Erreur de connexion sur le server distant + fichier_renvoye_par_le_fournisseur_de_donnees_non_valide_08054: + value: + errors: + - code: '08054' + title: Fichier renvoyé par le fournisseur de données non valide + detail: L'URL vers le document renvoyée par le fournisseur de + données est invalide + source: + meta: {} + summary: Fichier renvoyé par le fournisseur de données non valide + description: L'URL vers le document renvoyée par le fournisseur + de données est invalide + fichier_renvoye_par_le_fournisseur_de_donnees_non_valide_08055: + value: + errors: + - code: '08055' + title: Fichier renvoyé par le fournisseur de données non valide + detail: Le fichier n'est pas au format attendu + source: + meta: {} + summary: Fichier renvoyé par le fournisseur de données non valide + description: Le fichier n'est pas au format attendu + schema: + "$ref": "#/components/schemas/Error" + '404': + description: Non trouvé + content: + application/json: + examples: + entite_non_trouvee_08003: + value: + errors: + - code: '08003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: CNETP + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. + schema: + "$ref": "#/components/schemas/Error" + '504': + description: Erreur d'intermédiaire + content: + application/json: + examples: + timeout_error: + value: + errors: + - code: '08002' + title: Intermédiaire hors-délai + detail: Temps d’attente d’une réponse du fournisseur de données + écoulé. + source: + meta: + provider: CNETP + summary: Intermédiaire hors-délai + description: Temps d’attente d’une réponse du fournisseur de données + écoulé. + provider_unavailable_error: + value: + errors: + - code: '08001' + title: Service non disponible + detail: Service du fournisseur de données temporairement indisponible + ou en maintenance. + source: + meta: + provider: CNETP + summary: Service non disponible + description: Service du fournisseur de données temporairement indisponible + ou en maintenance. + network_error: + value: + errors: + - code: '00501' + title: Erreur réseau + detail: Problème de connexion au serveur distant. L'erreur peut + venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + source: + meta: + retry_in: 10 + summary: Erreur réseau + description: Problème de connexion au serveur distant. L'erreur + peut venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + dns_resolution_error: + value: + errors: + - code: '08004' + title: Erreur de résolution DNS + detail: Problème de résolution DNS de l'adresse du serveur + source: + meta: + provider: CNETP + summary: Erreur de résolution DNS + description: Problème de résolution DNS de l'adresse du serveur + schema: + "$ref": "#/components/schemas/Error" + x-maintenances: + from_hour: '06:00' + to_hour: '06:30' + x-codeSamples: + - lang: cURL + label: Ligne de commande + source: |- + curl -X GET \ + -H "Authorization: Bearer $token" \ + --url "https://entreprise.api.gouv.fr/v3/cnetp/unites_legales/130025265/attestation_cotisations_conges_payes_chomage_intemperies?context=Test+de+l%27API&object=Test+de+l%27API&recipient=10000001700010" + "/v3/douanes/etablissements/{siret_or_eori}/immatriculations_eori": + get: + summary: Immatriculation EORI + tags: + - Informations générales + parameters: + - name: siret_or_eori + in: path + description: Siret ou numéro EORI de l'entreprise + examples: + french_siret: + value: '16002307300010' + summary: Siret français + french_eori: + value: FR16002307300010 + summary: Numéro EORI français + spanish_eori: + value: ESA08536583 + summary: Numéro EORI espagnol + required: true + schema: + type: string - name: recipient in: query description: |- @@ -2886,6 +3208,16 @@ paths: required: true schema: type: string + - name: context + in: query + description: |- + "**Cadre de la requête** + + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test + required: true + schema: + type: string - name: object in: query description: |- @@ -2920,35 +3252,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -3137,6 +3451,23 @@ paths: description: Non trouvée content: application/json: + examples: + entite_non_trouvee_16003: + value: + errors: + - code: '16003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: DGDDI + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '502': @@ -3144,7 +3475,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '16999' @@ -3273,23 +3604,23 @@ paths: de données. schema: type: string - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -3325,35 +3656,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -3465,7 +3778,7 @@ paths: example: 7889238 description: 'Nombre de secondes avant l''expiration de l''url associée à l''attribut document_url : cette durée correspond - généralement à 3 mois.' + généralement à 24h.' required: - document_url - expires_in @@ -3481,6 +3794,23 @@ paths: description: Non trouvée content: application/json: + examples: + entite_non_trouvee_03003: + value: + errors: + - code: '03003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: DGFIP - Adélie + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '422': @@ -3539,7 +3869,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '03999' @@ -3724,23 +4054,23 @@ paths: de données. schema: type: string - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -3776,35 +4106,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -3950,6 +4262,23 @@ paths: description: Non trouvée content: application/json: + examples: + entite_non_trouvee_03003: + value: + errors: + - code: '03003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: DGFIP - Adélie + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '422': @@ -4008,7 +4337,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '03999' @@ -4154,14 +4483,11 @@ paths: tags: - Informations financières parameters: - - name: context - in: query - description: |- - "**Cadre de la requête** - - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test - required: true + - name: Cache-Control + in: header + description: Si cette valeur est fixée à "no-cache", le système de cache est + alors ignoré et la donnée est directement récupérée depuis le fournisseur + de données. schema: type: string - name: recipient @@ -4174,6 +4500,16 @@ paths: required: true schema: type: string + - name: context + in: query + description: |- + "**Cadre de la requête** + + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test + required: true + schema: + type: string - name: object in: query description: |- @@ -4239,35 +4575,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -4325,6 +4643,22 @@ paths: '200': description: Exercices trouvés headers: + X-Response-Cached: + schema: + type: boolean + example: true + enum: + - true + - false + default: false + description: Indique si la réponse a été caché. + X-Cache-Expires-in: + schema: + type: number + nullable: true + example: 9001 + description: Secondes avant que le cache n'expire. Si le cache est vide, + ce header est vide (mais présent). La durée du cache est de 1 heure. RateLimit-Limit: schema: type: integer @@ -4381,6 +4715,23 @@ paths: description: Non trouvée content: application/json: + examples: + entite_non_trouvee_03003: + value: + errors: + - code: '03003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: DGFIP - Adélie + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '422': @@ -4439,7 +4790,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '03999' @@ -4531,14 +4882,11 @@ paths: tags: - Informations financières parameters: - - name: context - in: query - description: |- - "**Cadre de la requête** - - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test - required: true + - name: Cache-Control + in: header + description: Si cette valeur est fixée à "no-cache", le système de cache est + alors ignoré et la donnée est directement récupérée depuis le fournisseur + de données. schema: type: string - name: recipient @@ -4551,6 +4899,16 @@ paths: required: true schema: type: string + - name: context + in: query + description: |- + "**Cadre de la requête** + + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test + required: true + schema: + type: string - name: object in: query description: |- @@ -4593,35 +4951,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -4679,6 +5019,22 @@ paths: '200': description: Entreprise trouvée headers: + X-Response-Cached: + schema: + type: boolean + example: true + enum: + - true + - false + default: false + description: Indique si la réponse a été caché. + X-Cache-Expires-in: + schema: + type: number + nullable: true + example: 9001 + description: Secondes avant que le cache n'expire. Si le cache est vide, + ce header est vide (mais présent). La durée du cache est de 1 heure. RateLimit-Limit: schema: type: integer @@ -4959,6 +5315,23 @@ paths: description: Pas de liasses fiscales pour cette unité légale content: application/json: + examples: + entite_non_trouvee_03003: + value: + errors: + - code: '03003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: DGFIP - Adélie + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '422': @@ -5017,7 +5390,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '03999' @@ -5146,23 +5519,23 @@ paths: de données. schema: type: string - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -5198,35 +5571,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -6676,6 +7031,8 @@ paths: - LAS - RCC - RIN + - NJO + - CJO libelle: type: string title: Libellé du sous-type @@ -6838,6 +7195,23 @@ paths: description: Association non trouvée content: application/json: + examples: + entite_non_trouvee_29003: + value: + errors: + - code: '29003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: DJEPVA + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '504': @@ -6904,7 +7278,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '29999' @@ -6947,23 +7321,23 @@ paths: required: true schema: type: string - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -6999,35 +7373,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -8250,6 +8606,23 @@ paths: description: Association non trouvée content: application/json: + examples: + entite_non_trouvee_29003: + value: + errors: + - code: '29003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: DJEPVA + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '504': @@ -8316,7 +8689,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '29999' @@ -8346,23 +8719,23 @@ paths: tags: - Informations générales parameters: - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -8402,35 +8775,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -8517,6 +8872,23 @@ paths: description: Non trouvée content: application/json: + examples: + entite_non_trouvee_28003: + value: + errors: + - code: '28003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: Commission Européenne + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '422': @@ -8575,7 +8947,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '28999' @@ -8661,26 +9033,27 @@ paths: "/v3/fabrique_numerique_ministeres_sociaux/etablissements/{siret}/conventions_collectives": get: summary: Conventions collectives + deprecated: true tags: - Informations générales parameters: - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -8749,35 +9122,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -9001,6 +9356,23 @@ paths: description: Non trouvée content: application/json: + examples: + entite_non_trouvee_14003: + value: + errors: + - code: '14003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: Fabrique numérique des Ministères Sociaux + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '502': @@ -9008,7 +9380,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '14999' @@ -9097,23 +9469,23 @@ paths: tags: - Attestations sociales et fiscales parameters: - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -9154,35 +9526,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -9277,7 +9631,7 @@ paths: example: 7889238 description: 'Nombre de secondes avant l''expiration de l''url associée à l''attribut document_url : cette durée correspond - généralement à 3 mois.' + généralement à 24h.' required: - document_url - expires_in @@ -9345,7 +9699,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '12999' @@ -9420,6 +9774,23 @@ paths: description: Non trouvée content: application/json: + examples: + entite_non_trouvee_12003: + value: + errors: + - code: '12003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: FNTP + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '504': @@ -9494,23 +9865,23 @@ paths: tags: - Informations générales parameters: - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -9582,35 +9953,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -9806,6 +10159,23 @@ paths: description: Effectifs non trouvés content: application/json: + examples: + entite_non_trouvee_31003: + value: + errors: + - code: '31003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: GIP-MDS + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '502': @@ -9813,7 +10183,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '31999' @@ -9902,23 +10272,23 @@ paths: tags: - Informations générales parameters: - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -10007,35 +10377,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -10253,6 +10605,23 @@ paths: description: Effectifs non trouvés content: application/json: + examples: + entite_non_trouvee_31003: + value: + errors: + - code: '31003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: GIP-MDS + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '502': @@ -10260,7 +10629,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '31999' @@ -10349,23 +10718,23 @@ paths: tags: - Informations générales parameters: - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -10433,35 +10802,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -10707,7 +11058,11 @@ paths: se voir affecter la valeur '00.00Z' de manière provisoire. \n \n Plus d'informations métier : https://entreprendre.service-public.fr/vosdroits/F33050 Nomemclature d'activité française - NAF rév.2 de l'Insee - : https://www.insee.fr/fr/information/2120875" + : https://www.insee.fr/fr/information/2120875. \n \n + ⚠️ À partir de janvier 2026, le code APE utilisera la + nouvelle nomenclature NAF 2025, tel qu'explicité dans + ce document : https://www.cnis.fr/evenements/la-revision-de-la-nomenclature-dactivites-francaise-naf-quels-effets-pour-les-utilisateurs/?category=1067. + Des tables de correspondance seront fournies par l'Insee." example: 6420Z required: - activite @@ -11057,6 +11412,23 @@ paths: description: Non trouvée content: application/json: + examples: + entite_non_trouvee_02003: + value: + errors: + - code: '02003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: Infogreffe + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '502': @@ -11064,7 +11436,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '02999' @@ -11185,23 +11557,23 @@ paths: required: true schema: type: string - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -11236,35 +11608,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -11589,6 +11943,23 @@ paths: description: Entreprise non trouvée content: application/json: + examples: + entite_non_trouvee_02003: + value: + errors: + - code: '02003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: Infogreffe + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '502': @@ -11596,7 +11967,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '02999' @@ -11679,29 +12050,29 @@ paths: curl -X GET \ -H "Authorization: Bearer $token" \ --url "https://entreprise.api.gouv.fr/v3/infogreffe/rcs/unites_legales/130025265/mandataires_sociaux?context=Test+de+l%27API&object=Test+de+l%27API&recipient=10000001700010" - "/v3/inpi/unites_legales/{siren}/actes": + "/v3/inpi/unites_legales/{siren}/brevets": get: - summary: Actes + summary: Brevets déposés tags: - - Informations générales + - Propriété intellectuelle parameters: - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -11720,10 +12091,17 @@ paths: required: true schema: type: string + - name: limit + in: query + description: Limite le nombre de résultats retournés. Valeur entre 1 et 20 + (Défaut 5) + example: 10 + schema: + type: number security: - jwt_bearer_token: [] - description: 'Actes issus des greffes et archivés à l’Institut national de propriété - industrielle (Inpi). + description: 'Nombre de brevets déposés par l''entreprise (lorsque le SIREN + a été spécifié) et informations sur les brevets les plus récents. ' responses: @@ -11743,35 +12121,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -11827,7 +12187,7 @@ paths: schema: "$ref": "#/components/schemas/Error" '200': - description: Actes trouvés + description: Brevets trouvés headers: RateLimit-Limit: schema: @@ -11846,7 +12206,7 @@ paths: type: integer description: La fin de la période courante (en format timestamp) example: 1637223155 - x-operationId: api_entreprise_v3_inpi_actes + x-operationId: api_entreprise_v3_inpi_latest_brevets content: application/json: schema: @@ -11860,44 +12220,163 @@ paths: data: type: object properties: + numero_publication: + title: Numéro de publication + description: Numéro de publication du brevet, constitué + du code zone + numéro du brevet + catégorie de publication + type: string + example: FR3110115A1 type: title: Type de la ressource type: string - example: acte + example: brevet enum: - - acte - siren: - title: Numéro Siren - description: Numéro SIREN de l'entreprise concernée - par l'acte + - brevet + titre: + title: Titre + description: Titre du brevet type: string - example: '788242667' - code_greffe: - title: Code greffe - description: Code identifiant du greffe ayant traité - l'acte - type: number - example: 5752 + example: DETERMINATION DE PARAMETRES D'UN MODELE + DYNAMIQUE POUR UNE CELLULE ELECTROCHIMIQUE DE BATTERIE + date_publication: + title: Date de publication + description: Date de publication du brevet + type: string + format: date + example: '2017-06-16' date_depot: - title: Date dépot - description: Date à laquelle a été déposé l'acte + title: Date de dépot + description: Date de dépot du brevet + type: string + format: date + example: '2015-12-14' + code_zone: + description: | + Code de deux lettres représentant la zone géographique où le brevet a été déposé, en fonction + de l'organisation qui a enregistré le brevet. + type: string + example: FR + enum: + - AL + - AP + - AR + - AT + - AU + - BA + - BE + - BG + - BR + - CA + - CH + - CL + - CN + - CO + - CR + - CS + - CU + - CY + - CZ + - DD + - DE + - DK + - DZ + - EA + - EC + - EE + - EG + - EP + - ES + - FI + - FR + - GB + - GC + - GE + - GR + - GT + - HK + - HR + - HU + - ID + - IE + - IL + - IN + - IS + - IT + - JP + - KE + - KR + - LI + - LT + - LU + - LV + - MA + - MC + - MD + - ME + - MK + - MN + - MT + - MW + - MX + - MY + - NC + - NI + - NL + - false + - NZ + - OA + - PA + - PE + - PH + - PL + - PT + - RO + - RS + - RU + - SE + - SG + - SI + - SK + - SM + - SU + - SV + - TJ + - TR + - TT + - TW + - UA + - US + - UY + - VN + - WO + - YU + - ZA + - ZM + - ZW + - + numero_brevet: + title: Numéro du brevet + description: 'Numéro du brevet dans l''organisation + ou il a été déposé (déterminée par le code de zone) + + ' type: string - example: '2017-06-16' - nature_archive: - title: Nature de l'archive de l'acte - description: 'Chaîne de caractères contenant une ou - plusieurs lettres séparées par un tiret, explicitant - de quelle(s) catégories d''archives l''acte provient: - A (actes de sociétés) R (ordonnances) et P (actes - de personnes physiques)' + example: '3110115' + categorie_publication: + title: Catégorie + description: 'Code représentant la catégorie du brevet + (ex: A1 pour une demande de brevet,' type: string - example: A-R + example: A1 required: + - numero_publication - type - - siren - - code_greffe + - titre + - date_publication - date_depot - - nature_archive + - code_zone + - numero_brevet + - categorie_publication links: type: object meta: @@ -11960,9 +12439,26 @@ paths: schema: "$ref": "#/components/schemas/Error" '404': - description: Actes non trouvés + description: Brevets non trouvés content: application/json: + examples: + entite_non_trouvee_05003: + value: + errors: + - code: '05003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: INPI + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '502': @@ -11970,7 +12466,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '05999' @@ -12052,30 +12548,30 @@ paths: source: |- curl -X GET \ -H "Authorization: Bearer $token" \ - --url "https://entreprise.api.gouv.fr/v3/inpi/unites_legales/130025265/actes?context=Test+de+l%27API&object=Test+de+l%27API&recipient=10000001700010" - "/v3/inpi/unites_legales/{siren}/brevets": + --url "https://entreprise.api.gouv.fr/v3/inpi/unites_legales/130025265/brevets?context=Test+de+l%27API&object=Test+de+l%27API&recipient=10000001700010" + "/v3/inpi/unites_legales/{siren}/marques": get: - summary: Brevets déposés + summary: Marques déposées tags: - Propriété intellectuelle parameters: - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -12103,8 +12599,8 @@ paths: type: number security: - jwt_bearer_token: [] - description: 'Nombre de brevets déposés par l''entreprise (lorsque le SIREN - a été spécifié) et informations sur les brevets les plus récents. + description: 'Nombre de marques déposées par l''entreprise (lorsque le SIREN + a été spécifié) et informations sur les marques les plus récentes. ' responses: @@ -12124,35 +12620,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -12208,7 +12686,7 @@ paths: schema: "$ref": "#/components/schemas/Error" '200': - description: Brevets trouvés + description: Marques trouvées headers: RateLimit-Limit: schema: @@ -12227,179 +12705,79 @@ paths: type: integer description: La fin de la période courante (en format timestamp) example: 1637223155 - x-operationId: api_entreprise_v3_inpi_latest_brevets + x-operationId: api_entreprise_v3_inpi_latest_marques content: application/json: - schema: - type: object - properties: - data: - type: array - items: - type: object - properties: - data: - type: object - properties: - numero_publication: - title: Numéro de publication - description: Numéro de publication du brevet, constitué - du code zone + numéro du brevet + catégorie de publication - type: string - example: FR3110115A1 - type: - title: Type de la ressource - type: string - example: brevet - enum: - - brevet - titre: - title: Titre - description: Titre du brevet - type: string - example: DETERMINATION DE PARAMETRES D'UN MODELE - DYNAMIQUE POUR UNE CELLULE ELECTROCHIMIQUE DE BATTERIE - date_publication: - title: Date de publication - description: Date de publication du brevet - type: string - format: date - example: '2017-06-16' - date_depot: - title: Date de dépot - description: Date de dépot du brevet - type: string - format: date - example: '2015-12-14' - code_zone: - description: | - Code de deux lettres représentant la zone géographique où le brevet a été déposé, en fonction - de l'organisation qui a enregistré le brevet. - type: string - example: FR - enum: - - AL - - AP - - AR - - AT - - AU - - BA - - BE - - BG - - BR - - CA - - CH - - CL - - CN - - CO - - CR - - CS - - CU - - CY - - CZ - - DD - - DE - - DK - - DZ - - EA - - EC - - EE - - EG - - EP - - ES - - FI - - FR - - GB - - GC - - GE - - GR - - GT - - HK - - HR - - HU - - ID - - IE - - IL - - IN - - IS - - IT - - JP - - KE - - KR - - LI - - LT - - LU - - LV - - MA - - MC - - MD - - ME - - MK - - MN - - MT - - MW - - MX - - MY - - NC - - NI - - NL - - false - - NZ - - OA - - PA - - PE - - PH - - PL - - PT - - RO - - RS - - RU - - SE - - SG - - SI - - SK - - SM - - SU - - SV - - TJ - - TR - - TT - - TW - - UA - - US - - UY - - VN - - WO - - YU - - ZA - - ZM - - ZW - - - numero_brevet: - title: Numéro du brevet - description: 'Numéro du brevet dans l''organisation - ou il a été déposé (déterminée par le code de zone) - - ' + schema: + type: object + properties: + data: + type: array + items: + type: object + properties: + data: + type: object + properties: + numero_application: + title: Numéro d'identification type: string - example: '3110115' - categorie_publication: - title: Catégorie - description: 'Code représentant la catégorie du brevet - (ex: A1 pour une demande de brevet,' + example: '4313464' + type: + title: Type de la ressource type: string - example: A1 + example: marque + enum: + - marque + nom: + title: Nom + type: string + example: DISTRIGO PARTS DISTRIBUTION + nullable: true + status: + title: Statut + type: string + example: Marque enregistrée + enum: + - Demande déposée + - Demande publiée + - Demande non publiée + - Demande irrecevable après publication + - Marque enregistrée + - Renouvellement demandé + - Marque renouvelée + - Demande totalement rejetée + - Marque ayant fait l'objet d'une renonciation totale + - Marque ayant fait l'objet d'un retrait total + - Marque annulée + - Marque expirée + depositaire: + title: Dépositaire + description: Nom de déposant ou titulaire + type: string + example: PEUGEOT CITROËN AUTOMOBILES SA, Société anonyme + clef: + title: Clef + type: string + example: FMARK|4313464 required: - - numero_publication + - numero_application - type - - titre - - date_publication - - date_depot - - code_zone - - numero_brevet - - categorie_publication + - nom + - status + - depositaire + - clef links: type: object + properties: + notice: + type: string + example: https://opendata-pi.inpi.fr/inpi/marques/notice/FR4313464 + description: Lien vers la notice concernant ce dépôt + de marque, au format XML. + required: + - notice + additionalProperties: false meta: type: object meta: @@ -12460,9 +12838,26 @@ paths: schema: "$ref": "#/components/schemas/Error" '404': - description: Brevets non trouvés + description: Marques non trouvées content: application/json: + examples: + entite_non_trouvee_05003: + value: + errors: + - code: '05003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: INPI + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '502': @@ -12470,7 +12865,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '05999' @@ -12552,30 +12947,30 @@ paths: source: |- curl -X GET \ -H "Authorization: Bearer $token" \ - --url "https://entreprise.api.gouv.fr/v3/inpi/unites_legales/130025265/brevets?context=Test+de+l%27API&object=Test+de+l%27API&recipient=10000001700010" - "/v3/inpi/unites_legales/{siren}/marques": + --url "https://entreprise.api.gouv.fr/v3/inpi/unites_legales/130025265/marques?context=Test+de+l%27API&object=Test+de+l%27API&recipient=10000001700010" + "/v3/inpi/unites_legales/{siren}/modeles": get: - summary: Marques déposées + summary: Modèles déposés tags: - Propriété intellectuelle parameters: - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -12603,8 +12998,8 @@ paths: type: number security: - jwt_bearer_token: [] - description: 'Nombre de marques déposées par l''entreprise (lorsque le SIREN - a été spécifié) et informations sur les marques les plus récentes. + description: 'Nombre de modèles déposés par l''entreprise (lorsque le SIREN + a été spécifié) et informations sur les modèles les plus récents. ' responses: @@ -12624,35 +13019,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -12708,7 +13085,7 @@ paths: schema: "$ref": "#/components/schemas/Error" '200': - description: Marques trouvées + description: Modèles trouvés headers: RateLimit-Limit: schema: @@ -12727,7 +13104,7 @@ paths: type: integer description: La fin de la période courante (en format timestamp) example: 1637223155 - x-operationId: api_entreprise_v3_inpi_latest_marques + x-operationId: api_entreprise_v3_inpi_latest_modeles content: application/json: schema: @@ -12741,62 +13118,84 @@ paths: data: type: object properties: - numero_application: - title: Numéro d'identification + document_id: + title: Identifiant + description: 'Identifiant du modèle dans la base de + l''INPI, constitué du code de l''office de dépôt (ex: + FR), du numéro national de dépôt (ex: 20203928) et + du numéro de référence (ex: 001) ' type: string - example: '4313464' + example: FR20203928-001 type: title: Type de la ressource type: string - example: marque + example: modele enum: - - marque - nom: - title: Nom + - modele + numero_depot: + title: Numéro national de dépôt + description: Numéro national sous lequel le modèle est + enregistré. type: string - example: DISTRIGO PARTS DISTRIBUTION - nullable: true - status: - title: Statut + example: '20203928' + titre: + title: Titre + description: Titre du modèle. type: string - example: Marque enregistrée - enum: - - Demande déposée - - Demande publiée - - Demande non publiée - - Demande irrecevable après publication - - Marque enregistrée - - Renouvellement demandé - - Marque renouvelée - - Demande totalement rejetée - - Marque ayant fait l'objet d'une renonciation totale - - Marque ayant fait l'objet d'un retrait total - - Marque annulée - - Marque expirée - depositaire: - title: Dépositaire - description: Nom de déposant ou titulaire + example: Véhicule automobile, vues de détails + total_representations: + title: Représentations totales + description: Nombre de représentations (vues) du modèle + type: number + example: 7 + deposant: + title: Déposant + description: Nom de l'entité ayant déposé le modèle. type: string - example: PEUGEOT CITROËN AUTOMOBILES SA, Société anonyme - clef: - title: Clef + example: PSA AUTOMOBILES, SA + date_depot: + title: Date de dépôt + description: Date à laquelle le modèle a été déposé + pour publication type: string - example: FMARK|4313464 + example: '2015-12-14' + date_publication: + title: Date de publication + description: Date de publication du modèle + type: string + example: '2015-12-14' + classe: + title: Code de classification + description: Code de classification du modèle, sur 4 + chiffres + type: string + example: '2606' + reference: + title: Numéro de réference + description: Numéro de référence du modèle par entité, + sur trois chiffres. Le premier modèle d'une entité + est numéroté 001, le second 002, etc. + type: string + example: '001' required: - - numero_application + - document_id - type - - nom - - status - - depositaire - - clef + - numero_depot + - titre + - total_representations + - deposant + - date_depot + - date_publication + - classe + - reference links: type: object properties: notice: type: string - example: https://opendata-pi.inpi.fr/inpi/marques/notice/FR4313464 + example: https://opendata-pi.inpi.fr/inpi/modeles/notice/FR20203928?ref=006 description: Lien vers la notice concernant ce dépôt - de marque, au format XML. + de modèle, au format XML required: - notice additionalProperties: false @@ -12860,9 +13259,26 @@ paths: schema: "$ref": "#/components/schemas/Error" '404': - description: Marques non trouvées + description: Modèles non trouvés content: application/json: + examples: + entite_non_trouvee_05003: + value: + errors: + - code: '05003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: INPI + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '502': @@ -12870,7 +13286,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '05999' @@ -12952,30 +13368,30 @@ paths: source: |- curl -X GET \ -H "Authorization: Bearer $token" \ - --url "https://entreprise.api.gouv.fr/v3/inpi/unites_legales/130025265/marques?context=Test+de+l%27API&object=Test+de+l%27API&recipient=10000001700010" - "/v3/inpi/unites_legales/{siren}/modeles": + --url "https://entreprise.api.gouv.fr/v3/inpi/unites_legales/130025265/modeles?context=Test+de+l%27API&object=Test+de+l%27API&recipient=10000001700010" + "/v3/inpi/rne/unites_legales/open_data/{siren}/actes_bilans": get: - summary: Modèles déposés + summary: Actes et bilans tags: - - Propriété intellectuelle + - Prochainement parameters: - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -12994,19 +13410,11 @@ paths: required: true schema: type: string - - name: limit - in: query - description: Limite le nombre de résultats retournés. Valeur entre 1 et 20 - (Défaut 5) - example: 10 - schema: - type: number security: - jwt_bearer_token: [] - description: 'Nombre de modèles déposés par l''entreprise (lorsque le SIREN - a été spécifié) et informations sur les modèles les plus récents. - - ' + description: | + Liste des actes et bilans d'une unité légale inscrite au répertoire national des entreprises (RNE). + Seuls les actes et bilans publiques sont distribués. L'INPI peut potentiellement posséder des actes et bilans "partiellement confidentiels". responses: '401': description: Non autorisé @@ -13024,35 +13432,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -13108,7 +13498,7 @@ paths: schema: "$ref": "#/components/schemas/Error" '200': - description: Modèles trouvés + description: Entreprise trouvée headers: RateLimit-Limit: schema: @@ -13127,109 +13517,144 @@ paths: type: integer description: La fin de la période courante (en format timestamp) example: 1637223155 - x-operationId: api_entreprise_v3_inpi_latest_modeles + x-operationId: api_entreprise_v3_inpi_rne_actes_bilans content: application/json: schema: type: object properties: data: - type: array - items: - type: object - properties: - data: + type: object + properties: + actes: + title: Liste des documents contenant les actes de l'unité + légale + description: | + Ce tableau liste les documents, classés par + date de mise à jour, et à défaut date de dépôt du document. Un document + peut contenir un ou plusieurs actes dont le type est décrit + dans la métadonnée. + type: array + items: type: object properties: - document_id: - title: Identifiant - description: 'Identifiant du modèle dans la base de - l''INPI, constitué du code de l''office de dépôt (ex: - FR), du numéro national de dépôt (ex: 20203928) et - du numéro de référence (ex: 001) ' + id: + title: Identifiant de l'acte type: string - example: FR20203928-001 - type: - title: Type de la ressource + example: 65419234a1f7d1f2ba09bd8c + nom_document: + title: Nom du document à l'Inpi + description: Nom du document déposé. type: string - example: modele - enum: - - modele - numero_depot: - title: Numéro national de dépôt - description: Numéro national sous lequel le modèle est - enregistré. + example: X9wvz5eKvKQv_C0022A1001L257081D20230902H180411TPIJTES003PDBOR + date_depot: + title: Date de dépôt du document type: string - example: '20203928' - titre: - title: Titre - description: Titre du modèle. + format: date + example: '2023-08-08' + date_mise_a_jour: + title: Date de mise à jour du document type: string - example: Véhicule automobile, vues de détails - total_representations: - title: Représentations totales - description: Nombre de représentations (vues) du modèle - type: number - example: 7 - deposant: - title: Déposant - description: Nom de l'entité ayant déposé le modèle. + format: date + example: '2023-11-01' + types_actes: + title: Types d'actes contenus dans le document + type: array + description: | + Liste les types d'actes inclus dans le document retourné. + Pour les documents qui ont été établis avant la création du répertoire des entreprises (RNE) + et qui étaient autrefois transmis par les greffes au registre national du commerce et des sociétés (RNCS), + le document est souvent constitué de plusieurs actes distincts (exemple: le même document peut contenir + une modification de l'adresse du siège social + et une modification du capital social). Les actes qui sont maintenant déposés au guichet unique ne sont + jamais regroupés dans un même document. + nullable: true + items: + type: object + properties: + type_acte: + title: Type d'acte + description: | + Intitulé décrivant le type de l'acte. + Les intitulés les plus fréquents sont : Acte, Certificat, Procès-verbal, + Statuts mis à jour, Extrait de procès-verbal, etc. + type: string + example: Procès-verbal + type_decision: + title: Type de décision + description: | + Intitulé décrivant le type de décision prise par l'acte. + Les intitulés sont par exemple : Décision d'augmentation, Modification(s) statutaire(s), + Augmentation du capital social, Fin de mission de commissaire aux comptes titulaire, + Nomination(s) d'administrateur(s), etc. + type: string + example: Augmentation du capital social + nullable: true + url: + title: URL du document type: string - example: PSA AUTOMOBILES, SA + example: https://entreprise.api.gouv.fr/proxy/inpi/download/%2FV+svyVVJGVCJroamyqjOrECaXHorkxJ39vZH1IMHz4N+6gvit9zgoQ=--rJ1ss+Brc7oVhloH--huyvWA83YgMFqOnjyKDmXQ== + bilans: + title: Liste des bilans de l'unité légale + type: array + items: + type: object + properties: + id: + title: Identifiant du bilan + type: string + example: 65419234a1f7d1f2ba09bd8c + nom_document: + title: Nom du bilan + description: Nom du bilan à l'Inpi. + type: string + example: X9wvz5eKvKQv_C0022A1001L257081D20230902H180411TPIJTES003PDBOR date_depot: - title: Date de dépôt - description: Date à laquelle le modèle a été déposé - pour publication + title: Date de dépôt du bilan type: string - example: '2015-12-14' - date_publication: - title: Date de publication - description: Date de publication du modèle + format: date + example: '2023-08-08' + date_cloture: + title: Date de clôture du bilan type: string - example: '2015-12-14' - classe: - title: Code de classification - description: Code de classification du modèle, sur 4 - chiffres + format: date + example: '2023-08-08' + date_mise_a_jour: + title: Date de mise à jour du bilan type: string - example: '2606' - reference: - title: Numéro de réference - description: Numéro de référence du modèle par entité, - sur trois chiffres. Le premier modèle d'une entité - est numéroté 001, le second 002, etc. + format: date + example: '2023-11-01' + type: + title: Type de bilan + description: 'Type du bilan déposé. + + ' type: string - example: '001' - required: - - document_id - - type - - numero_depot - - titre - - total_representations - - deposant - - date_depot - - date_publication - - classe - - reference - links: - type: object - properties: - notice: + example: bilan complet + enum: + - bilan complet + - bilan simplifié + - bilan consolidé + - bilan de type banque + - bilan de type assurance + - bilan de type agricole simplifié + url: + title: URL du bilan + description: URL pour télécharger le document bilan type: string - example: https://opendata-pi.inpi.fr/inpi/modeles/notice/FR20203928?ref=006 - description: Lien vers la notice concernant ce dépôt - de modèle, au format XML - required: - - notice - additionalProperties: false - meta: - type: object - meta: - type: object + example: https://entreprise.api.gouv.fr/proxy/inpi/download/%2FV+svyVVJGVCJroamyqjOrECaXHorkxJ39vZH1IMHz4N+6gvit9zgoQ=--rJ1ss+Brc7oVhloH--huyvWA83YgMFqOnjyKDmXQ== + required: + - actes + - bilans + additionalProperties: false links: type: object + meta: + type: object required: - data + - links + - meta '422': description: Paramètre(s) invalide(s) content: @@ -13282,9 +13707,26 @@ paths: schema: "$ref": "#/components/schemas/Error" '404': - description: Modèles non trouvés + description: Non trouvée content: application/json: + examples: + entite_non_trouvee_34003: + value: + errors: + - code: '34003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: INPI - RNE + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '502': @@ -13292,17 +13734,17 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - - code: '05999' + - code: '34999' title: Erreur inconnue du fournisseur de données detail: La réponse retournée par le fournisseur de données est invalide et inconnue de notre service. L'équipe technique a été notifiée de cette erreur pour investigation. source: meta: - provider: INPI + provider: INPI - RNE summary: Erreur inconnue du fournisseur de données description: La réponse retournée par le fournisseur de données est invalide et inconnue de notre service. L'équipe technique @@ -13317,26 +13759,26 @@ paths: timeout_error: value: errors: - - code: '05002' + - code: '34002' title: Intermédiaire hors-délai detail: Temps d’attente d’une réponse du fournisseur de données écoulé. source: meta: - provider: INPI + provider: INPI - RNE summary: Intermédiaire hors-délai description: Temps d’attente d’une réponse du fournisseur de données écoulé. provider_unavailable_error: value: errors: - - code: '05001' + - code: '34001' title: Service non disponible detail: Service du fournisseur de données temporairement indisponible ou en maintenance. source: meta: - provider: INPI + provider: INPI - RNE summary: Service non disponible description: Service du fournisseur de données temporairement indisponible ou en maintenance. @@ -13358,12 +13800,12 @@ paths: dns_resolution_error: value: errors: - - code: '05004' + - code: '34004' title: Erreur de résolution DNS detail: Problème de résolution DNS de l'adresse du serveur source: meta: - provider: INPI + provider: INPI - RNE summary: Erreur de résolution DNS description: Problème de résolution DNS de l'adresse du serveur schema: @@ -13374,30 +13816,30 @@ paths: source: |- curl -X GET \ -H "Authorization: Bearer $token" \ - --url "https://entreprise.api.gouv.fr/v3/inpi/unites_legales/130025265/modeles?context=Test+de+l%27API&object=Test+de+l%27API&recipient=10000001700010" - "/v3/inpi/rne/unites_legales/open_data/{siren}/beneficiaires_effectifs": + --url "https://entreprise.api.gouv.fr/v3/inpi/rne/unites_legales/open_data/130025265/actes_bilans?context=Test+de+l%27API&object=Test+de+l%27API&recipient=10000001700010" + "/v3/inpi/rne/unites_legales/{siren}/beneficiaires_effectifs": get: summary: Bénéficiaires effectifs tags: - Informations générales parameters: - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -13471,35 +13913,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -13605,6 +14029,10 @@ paths: data: type: object properties: + beneficiaire_uuid: + title: UUID du bénéficiaire effectif + type: string + example: 21120ee0-d42b-44f6-a462-d3724cf6aeaf nom: title: Nom du bénéficiaire effectif type: string @@ -13631,10 +14059,12 @@ paths: title: Année de la date de naissance type: string example: '1990' + nullable: true mois: title: Mois de la date de naissance type: string example: '01' + nullable: true enum: - '01' - '02' @@ -13655,11 +14085,11 @@ paths: type: string title: Nationalité du bénéficiaire effectif example: France + nullable: true pays_residence: type: string title: Pays de résidence du bénéficiaire effectif example: FRANCE - nullable: true modalites: title: Liste des modalités de contrôle du bénéficiaire effectif @@ -14268,6 +14698,7 @@ paths: - representant_legal - representant_legal_placement_sans_gestion_deleguee required: + - beneficiaire_uuid - nom - nom_usage - prenoms @@ -14286,8 +14717,17 @@ paths: title: Nombre de bénéficiaires type: integer example: 1 + beneficiaires_sans_modalites_uuids: + title: UUIDs des bénéficiaires sans modalités + type: array + description: UUIDs des bénéficiaires qui ne sont pas affichés + car sans modalité (il s'agit de représentants légaux) + items: + type: string + example: 21120ee0-d42b-44f6-a462-d3724cf6aeaf required: - count + - beneficiaires_sans_modalites_uuids additionalProperties: false links: type: object @@ -14298,6 +14738,23 @@ paths: description: Bénéficiaires effectifs non trouvés content: application/json: + examples: + entite_non_trouvee_34003: + value: + errors: + - code: '34003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: INPI - RNE + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '422': @@ -14356,7 +14813,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '34999' @@ -14438,7 +14895,7 @@ paths: source: |- curl -X GET \ -H "Authorization: Bearer $token" \ - --url "https://entreprise.api.gouv.fr/v3/inpi/rne/unites_legales/open_data/130025265/beneficiaires_effectifs?context=Test+de+l%27API&object=Test+de+l%27API&recipient=10000001700010" + --url "https://entreprise.api.gouv.fr/v3/inpi/rne/unites_legales/130025265/beneficiaires_effectifs?context=Test+de+l%27API&object=Test+de+l%27API&recipient=10000001700010" "/v3/insee/sirene/etablissements/{siret}/adresse": get: summary: Adresse établissement @@ -14479,23 +14936,23 @@ paths: required: true schema: type: string - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -14530,35 +14987,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -14956,6 +15395,23 @@ paths: description: Non trouvé content: application/json: + examples: + entite_non_trouvee_01003: + value: + errors: + - code: '01003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: INSEE + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '502': @@ -14963,7 +15419,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '01999' @@ -15086,23 +15542,23 @@ paths: required: true schema: type: string - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -15137,35 +15593,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -15593,6 +16031,23 @@ paths: description: Non trouvé content: application/json: + examples: + entite_non_trouvee_01003: + value: + errors: + - code: '01003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: INSEE + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '502': @@ -15600,7 +16055,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '01999' @@ -15719,17 +16174,7 @@ paths: summary: SIRET pour Qualifelec siret_qualiopi: value: '81841109200013' - summary: SIRET pour Qualiopi - required: true - schema: - type: string - - name: context - in: query - description: |- - "**Cadre de la requête** - - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + summary: SIRET pour Qualiopi required: true schema: type: string @@ -15743,6 +16188,16 @@ paths: required: true schema: type: string + - name: context + in: query + description: |- + "**Cadre de la requête** + + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test + required: true + schema: + type: string - name: object in: query description: |- @@ -15774,35 +16229,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -15943,7 +16380,11 @@ paths: voir affecter la valeur '00.00Z' de manière provisoire. \n \n Plus d'informations métier : https://entreprendre.service-public.fr/vosdroits/F33050 Nomemclature d'activité française - NAF rév.2 de l'Insee - : https://www.insee.fr/fr/information/2120875" + : https://www.insee.fr/fr/information/2120875. \n \n + ⚠️ À partir de janvier 2026, le code APE utilisera la + nouvelle nomenclature NAF 2025, tel qu'explicité dans + ce document : https://www.cnis.fr/evenements/la-revision-de-la-nomenclature-dactivites-francaise-naf-quels-effets-pour-les-utilisateurs/?category=1067. + Des tables de correspondance seront fournies par l'Insee." libelle: title: Libellé associé au code APE type: string @@ -16355,7 +16796,12 @@ paths: valeur '00.00Z' de manière provisoire. \n \n Plus d'informations métier : https://entreprendre.service-public.fr/vosdroits/F33050 Nomemclature d'activité française - NAF rév.2 de - l'Insee : https://www.insee.fr/fr/information/2120875" + l'Insee : https://www.insee.fr/fr/information/2120875. + \n \n ⚠️ À partir de janvier 2026, le code APE utilisera + la nouvelle nomenclature NAF 2025, tel qu'explicité + dans ce document : https://www.cnis.fr/evenements/la-revision-de-la-nomenclature-dactivites-francaise-naf-quels-effets-pour-les-utilisateurs/?category=1067. + Des tables de correspondance seront fournies par + l'Insee." libelle: title: Libellé associé au code APE type: string @@ -16923,6 +17369,29 @@ paths: "$ref": "#/components/schemas/Error" '404': description: Non trouvé + content: + application/json: + examples: + entite_non_trouvee_01003: + value: + errors: + - code: '01003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: INSEE + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. + schema: + "$ref": "#/components/schemas/Error" + '451': + description: Indisponible pour des raisons légales content: application/json: schema: @@ -16932,7 +17401,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '01999' @@ -17055,23 +17524,23 @@ paths: required: true schema: type: string - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -17106,35 +17575,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -17275,7 +17726,11 @@ paths: voir affecter la valeur '00.00Z' de manière provisoire. \n \n Plus d'informations métier : https://entreprendre.service-public.fr/vosdroits/F33050 Nomemclature d'activité française - NAF rév.2 de l'Insee - : https://www.insee.fr/fr/information/2120875" + : https://www.insee.fr/fr/information/2120875. \n \n + ⚠️ À partir de janvier 2026, le code APE utilisera la + nouvelle nomenclature NAF 2025, tel qu'explicité dans + ce document : https://www.cnis.fr/evenements/la-revision-de-la-nomenclature-dactivites-francaise-naf-quels-effets-pour-les-utilisateurs/?category=1067. + Des tables de correspondance seront fournies par l'Insee." libelle: title: Libellé associé au code APE type: string @@ -17707,7 +18162,12 @@ paths: valeur '00.00Z' de manière provisoire. \n \n Plus d'informations métier : https://entreprendre.service-public.fr/vosdroits/F33050 Nomemclature d'activité française - NAF rév.2 de - l'Insee : https://www.insee.fr/fr/information/2120875" + l'Insee : https://www.insee.fr/fr/information/2120875. + \n \n ⚠️ À partir de janvier 2026, le code APE utilisera + la nouvelle nomenclature NAF 2025, tel qu'explicité + dans ce document : https://www.cnis.fr/evenements/la-revision-de-la-nomenclature-dactivites-francaise-naf-quels-effets-pour-les-utilisateurs/?category=1067. + Des tables de correspondance seront fournies par + l'Insee." libelle: title: Libellé associé au code APE type: string @@ -18305,6 +18765,23 @@ paths: description: Non trouvé content: application/json: + examples: + entite_non_trouvee_01003: + value: + errors: + - code: '01003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: INSEE + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '502': @@ -18312,7 +18789,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '01999' @@ -18433,23 +18910,23 @@ paths: required: true schema: type: string - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -18484,35 +18961,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -18653,7 +19112,11 @@ paths: voir affecter la valeur '00.00Z' de manière provisoire. \n \n Plus d'informations métier : https://entreprendre.service-public.fr/vosdroits/F33050 Nomemclature d'activité française - NAF rév.2 de l'Insee - : https://www.insee.fr/fr/information/2120875" + : https://www.insee.fr/fr/information/2120875. \n \n + ⚠️ À partir de janvier 2026, le code APE utilisera la + nouvelle nomenclature NAF 2025, tel qu'explicité dans + ce document : https://www.cnis.fr/evenements/la-revision-de-la-nomenclature-dactivites-francaise-naf-quels-effets-pour-les-utilisateurs/?category=1067. + Des tables de correspondance seront fournies par l'Insee." libelle: title: Libellé associé au code APE type: string @@ -19085,7 +19548,12 @@ paths: valeur '00.00Z' de manière provisoire. \n \n Plus d'informations métier : https://entreprendre.service-public.fr/vosdroits/F33050 Nomemclature d'activité française - NAF rév.2 de - l'Insee : https://www.insee.fr/fr/information/2120875" + l'Insee : https://www.insee.fr/fr/information/2120875. + \n \n ⚠️ À partir de janvier 2026, le code APE utilisera + la nouvelle nomenclature NAF 2025, tel qu'explicité + dans ce document : https://www.cnis.fr/evenements/la-revision-de-la-nomenclature-dactivites-francaise-naf-quels-effets-pour-les-utilisateurs/?category=1067. + Des tables de correspondance seront fournies par + l'Insee." libelle: title: Libellé associé au code APE type: string @@ -19683,6 +20151,23 @@ paths: description: Non trouvé content: application/json: + examples: + entite_non_trouvee_01003: + value: + errors: + - code: '01003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: INSEE + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '502': @@ -19690,7 +20175,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '01999' @@ -19811,23 +20296,23 @@ paths: required: true schema: type: string - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -19863,35 +20348,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -20032,7 +20499,11 @@ paths: voir affecter la valeur '00.00Z' de manière provisoire. \n \n Plus d'informations métier : https://entreprendre.service-public.fr/vosdroits/F33050 Nomemclature d'activité française - NAF rév.2 de l'Insee - : https://www.insee.fr/fr/information/2120875" + : https://www.insee.fr/fr/information/2120875. \n \n + ⚠️ À partir de janvier 2026, le code APE utilisera la + nouvelle nomenclature NAF 2025, tel qu'explicité dans + ce document : https://www.cnis.fr/evenements/la-revision-de-la-nomenclature-dactivites-francaise-naf-quels-effets-pour-les-utilisateurs/?category=1067. + Des tables de correspondance seront fournies par l'Insee." libelle: title: Libellé associé au code APE type: string @@ -20444,7 +20915,12 @@ paths: valeur '00.00Z' de manière provisoire. \n \n Plus d'informations métier : https://entreprendre.service-public.fr/vosdroits/F33050 Nomemclature d'activité française - NAF rév.2 de - l'Insee : https://www.insee.fr/fr/information/2120875" + l'Insee : https://www.insee.fr/fr/information/2120875. + \n \n ⚠️ À partir de janvier 2026, le code APE utilisera + la nouvelle nomenclature NAF 2025, tel qu'explicité + dans ce document : https://www.cnis.fr/evenements/la-revision-de-la-nomenclature-dactivites-francaise-naf-quels-effets-pour-les-utilisateurs/?category=1067. + Des tables de correspondance seront fournies par + l'Insee." libelle: title: Libellé associé au code APE type: string @@ -21014,6 +21490,23 @@ paths: description: Non trouvé content: application/json: + examples: + entite_non_trouvee_01003: + value: + errors: + - code: '01003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: INSEE + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '502': @@ -21021,7 +21514,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '01999' @@ -21144,23 +21637,23 @@ paths: required: true schema: type: string - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -21176,7 +21669,7 @@ paths: type: string security: - jwt_bearer_token: [] - description: Informations sur les liens de succession entre les établissements. + description: Liste des prédécesseurs et successeurs d'un établissement. responses: '401': description: Non autorisé @@ -21194,35 +21687,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -21308,62 +21783,68 @@ paths: properties: predecesseurs: title: Établissements prédécesseurs + description: Liste des établissements prédécesseurs de l'établissement + appelé. type: array items: type: object properties: siret: - title: Siret de l'établissement prédécesseur/successeur + title: SIRET type: string example: '30613890001294' - description: Siret de l'établissement prédécesseur ou - successeur + description: SIRET de l'établissement prédécesseur. date_succession: - title: Date de succession + title: Date d'effet du lien de succession type: date example: '2021-10-15' - description: Date de succession entre les établissements + description: Date à laquelle la succession a eu lieu. transfert_siege: title: Transfert de siège type: boolean example: true - description: Indique si la succession est un transfert - de siège. + description: 'Indique si la succession est un transfert + de siège. Pour en savoir plus, consulter cette rubrique + : http://entreprise.api.gouv.fr/catalogue/insee/successions#definition-transfert-siege.' continuite_economique: title: Continuité économique type: boolean example: true - description: Indique si la succession est une continuité - économique. + description: 'Indique si la succession est une continuité + économique. Pour en savoir plus, consulter cette rubrique + : http://entreprise.api.gouv.fr/catalogue/insee/successions#definition-continuite-economique.' successeurs: title: Établissements successeurs + description: Liste des établissements successeurs de l'établissement + appelé. type: array items: type: object properties: siret: - title: Siret de l'établissement prédécesseur/successeur + title: SIRET type: string example: '30613890001294' - description: Siret de l'établissement prédécesseur ou - successeur + description: SIRET de l'établissement successeur. date_succession: - title: Date de succession + title: Date d'effet du lien de succession type: date example: '2021-10-15' - description: Date de succession entre les établissements + description: Date à laquelle la succession a eu lieu. transfert_siege: title: Transfert de siège type: boolean example: true - description: Indique si la succession est un transfert - de siège. + description: 'Indique si la succession est un transfert + de siège. Pour en savoir plus, consulter cette rubrique + : http://entreprise.api.gouv.fr/catalogue/insee/successions#definition-transfert-siege.' continuite_economique: title: Continuité économique type: boolean example: true - description: Indique si la succession est une continuité - économique. + description: 'Indique si la succession est une continuité + économique. Pour en savoir plus, consulter cette rubrique + : http://entreprise.api.gouv.fr/catalogue/insee/successions#definition-continuite-economique.' required: - predecesseurs - successeurs @@ -21380,6 +21861,23 @@ paths: description: Non trouvée content: application/json: + examples: + entite_non_trouvee_01003: + value: + errors: + - code: '01003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: INSEE + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '422': @@ -21438,7 +21936,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '01999' @@ -21559,23 +22057,23 @@ paths: required: true schema: type: string - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -21611,35 +22109,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -21970,7 +22450,11 @@ paths: affecter la valeur '00.00Z' de manière provisoire. \n \n Plus d'informations métier : https://entreprendre.service-public.fr/vosdroits/F33050 Nomemclature d'activité française - NAF rév.2 de l'Insee - : https://www.insee.fr/fr/information/2120875" + : https://www.insee.fr/fr/information/2120875. \n \n + ⚠️ À partir de janvier 2026, le code APE utilisera la + nouvelle nomenclature NAF 2025, tel qu'explicité dans + ce document : https://www.cnis.fr/evenements/la-revision-de-la-nomenclature-dactivites-francaise-naf-quels-effets-pour-les-utilisateurs/?category=1067. + Des tables de correspondance seront fournies par l'Insee." libelle: title: Libellé associé au code APE type: string @@ -22262,6 +22746,23 @@ paths: description: Non trouvée content: application/json: + examples: + entite_non_trouvee_01003: + value: + errors: + - code: '01003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: INSEE + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '502': @@ -22269,7 +22770,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '01999' @@ -22396,23 +22897,23 @@ paths: required: true schema: type: string - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -22447,35 +22948,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -22825,7 +23308,11 @@ paths: affecter la valeur '00.00Z' de manière provisoire. \n \n Plus d'informations métier : https://entreprendre.service-public.fr/vosdroits/F33050 Nomemclature d'activité française - NAF rév.2 de l'Insee - : https://www.insee.fr/fr/information/2120875" + : https://www.insee.fr/fr/information/2120875. \n \n + ⚠️ À partir de janvier 2026, le code APE utilisera la + nouvelle nomenclature NAF 2025, tel qu'explicité dans + ce document : https://www.cnis.fr/evenements/la-revision-de-la-nomenclature-dactivites-francaise-naf-quels-effets-pour-les-utilisateurs/?category=1067. + Des tables de correspondance seront fournies par l'Insee." libelle: title: Libellé associé au code APE type: string @@ -23117,6 +23604,23 @@ paths: description: Non trouvée content: application/json: + examples: + entite_non_trouvee_01003: + value: + errors: + - code: '01003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: INSEE + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '502': @@ -23124,7 +23628,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '01999' @@ -23240,23 +23744,23 @@ paths: de données. schema: type: string - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -23291,35 +23795,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -23543,7 +24029,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '21999' @@ -23618,6 +24104,23 @@ paths: description: Association not found content: application/json: + examples: + entite_non_trouvee_21003: + value: + errors: + - code: '21003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: MI + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '504': @@ -23713,23 +24216,23 @@ paths: required: true schema: type: string - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -23764,35 +24267,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -24084,6 +24569,23 @@ paths: description: Association not found content: application/json: + examples: + entite_non_trouvee_21003: + value: + errors: + - code: '21003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: MI + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '504': @@ -24150,7 +24652,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '21999' @@ -24214,23 +24716,23 @@ paths: required: true schema: type: string - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -24265,35 +24767,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -24455,6 +24939,23 @@ paths: description: Non trouvée content: application/json: + examples: + entite_non_trouvee_10003: + value: + errors: + - code: '10003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: MSA + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '502': @@ -24462,7 +24963,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '10999' @@ -24554,23 +25055,23 @@ paths: tags: - Certifications professionnelles parameters: - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -24612,35 +25113,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -24904,6 +25387,23 @@ paths: description: Non trouvée content: application/json: + examples: + entite_non_trouvee_11003: + value: + errors: + - code: '11003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: OPQIBI + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '502': @@ -24911,7 +25411,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '11999' @@ -25034,23 +25534,23 @@ paths: required: true schema: type: string - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -25085,35 +25585,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -25208,7 +25690,7 @@ paths: example: 7889238 description: 'Nombre de secondes avant l''expiration de l''url associée à l''attribut document_url : cette durée correspond - généralement à 3 mois.' + généralement à 24h.' required: - document_url - expires_in @@ -25276,7 +25758,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '09999' @@ -25351,6 +25833,23 @@ paths: description: Attestation non trouvée content: application/json: + examples: + entite_non_trouvee_09003: + value: + errors: + - code: '09003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: ProBTP + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '504': @@ -25425,23 +25924,23 @@ paths: tags: - Attestations sociales et fiscales parameters: - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -25481,35 +25980,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -25667,6 +26148,23 @@ paths: description: Non trouvée content: application/json: + examples: + entite_non_trouvee_09003: + value: + errors: + - code: '09003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: ProBTP + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '502': @@ -25674,7 +26172,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '09999' @@ -25797,23 +26295,23 @@ paths: required: true schema: type: string - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -25849,35 +26347,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -25972,7 +26452,7 @@ paths: example: 7889238 description: 'Nombre de secondes avant l''expiration de l''url associée à l''attribut document_url : cette durée correspond - généralement à 3 mois.' + généralement à 24h.' required: - document_url - expires_in @@ -26040,7 +26520,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '06999' @@ -26115,6 +26595,23 @@ paths: description: Certification non trouvée content: application/json: + examples: + entite_non_trouvee_06003: + value: + errors: + - code: '06003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: Qualibat + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '504': @@ -26189,6 +26686,13 @@ paths: tags: - Certifications professionnelles parameters: + - name: Cache-Control + in: header + description: Si cette valeur est fixée à "no-cache", le système de cache est + alors ignoré et la donnée est directement récupérée depuis le fournisseur + de données. + schema: + type: string - name: siret in: path description: Siret de l'établissement @@ -26223,23 +26727,23 @@ paths: required: true schema: type: string - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -26274,35 +26778,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -26360,6 +26846,23 @@ paths: '200': description: Certification trouvée headers: + X-Response-Cached: + schema: + type: boolean + example: true + enum: + - true + - false + default: false + description: Indique si la réponse a été caché. + X-Cache-Expires-in: + schema: + type: number + nullable: true + example: 9001 + description: Secondes avant que le cache n'expire. Si le cache est vide, + ce header est vide (mais présent). Le cache est valide jusqu'à la + fin de la journée RateLimit-Limit: schema: type: integer @@ -26563,7 +27066,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '06999' @@ -26638,6 +27141,23 @@ paths: description: Certification non trouvée content: application/json: + examples: + entite_non_trouvee_06003: + value: + errors: + - code: '06003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: Qualibat + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '504': @@ -26746,23 +27266,23 @@ paths: required: true schema: type: string - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -26797,35 +27317,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -27032,7 +27534,9 @@ paths: humains possédés par l'entreprise pour réaliser les travaux liées à la qualification. Elle précise l'effectif du personnel d'exécution et d'encadrement - permanent de l'entreprise. + permanent de l'entreprise. Ce champ peut être + nul dans le cas où la qualification est une qualification + probatoire. type: object properties: code: @@ -27041,12 +27545,14 @@ paths: description: Code de la classification associé à la qualification. example: '1' + nullable: true label: title: Libellé de la classification type: string description: Libellé de la classification de la qualification. example: Classe 1 - de 1 à 3 exécutants + nullable: true required: - code - label @@ -27220,6 +27726,23 @@ paths: description: Non trouvée content: application/json: + examples: + entite_non_trouvee_32003: + value: + errors: + - code: '32003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: Qualifelec + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '502': @@ -27227,7 +27750,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '32999' @@ -27348,23 +27871,23 @@ paths: required: true schema: type: string - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -27400,35 +27923,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -27601,6 +28106,23 @@ paths: description: Entreprise non trouvée content: application/json: + examples: + entite_non_trouvee_22003: + value: + errors: + - code: '22003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: RNM + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '502': @@ -27608,7 +28130,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '22999' @@ -27736,23 +28258,23 @@ paths: de données. schema: type: string - - name: context + - name: recipient in: query description: |- - "**Cadre de la requête** + "**Bénéficiaire de l’appel** - Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." - example: Context de test + SIRET de l’administration destinatrice des données." + example: '13002526500013' required: true schema: type: string - - name: recipient + - name: context in: query description: |- - "**Bénéficiaire de l’appel** + "**Cadre de la requête** - SIRET de l’administration destinatrice des données." - example: '13002526500013' + Par exemple : aides publiques, marchés publics ou gestion d’un référentiel tiers utilisé pour tel type d’application." + example: Context de test required: true schema: type: string @@ -27788,35 +28310,17 @@ paths: meta: {} summary: Interdit description: Votre token n'est pas valide ou n'est pas renseigné - old_token_error: - value: - errors: - - code: '00102' - title: Format de jeton plus supporté - detail: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire - une demande à API Entreprise, un guide est disponible sur - https://entreprise.api.gouv.fr/demander_un_acces/ - source: - parameter: token - meta: {} - summary: Format de jeton plus supporté - description: Vous avez utilisé un token à l'ancien format. Ce format - n'est plus supporté depuis avril 2019. Vous devez refaire une - demande à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/demander_un_acces/ expired_token_error: value: errors: - code: '00103' title: Jeton expiré detail: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration source: parameter: token meta: {} summary: Jeton expiré description: Votre token est expiré. Vous devez refaire une demande - à API Entreprise, un guide est disponible sur https://entreprise.api.gouv.fr/faq#comment-renouveler-mon-jeton-arrivant-a-expiration blacklisted_token_error: value: errors: @@ -28065,7 +28569,7 @@ paths: content: application/json: examples: - unknown_error: + provider_unknown_error: value: errors: - code: '04999' @@ -28171,6 +28675,23 @@ paths: description: Entreprise non trouvée content: application/json: + examples: + entite_non_trouvee_04003: + value: + errors: + - code: '04003' + title: Entité non trouvée + detail: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez + vérifier que l'identifiant correspond au périmètre couvert + par l'API. + source: + meta: + provider: ACOSS + summary: Entité non trouvée + description: Le siret ou siren indiqué n'existe pas, n'est pas connu + ou ne comporte aucune information pour cet appel. Veuillez vérifier + que l'identifiant correspond au périmètre couvert par l'API. schema: "$ref": "#/components/schemas/Error" '504': diff --git a/config/api-particulier-openapi-v3.yml b/config/api-particulier-openapi-v3.yml new file mode 100644 index 000000000..1fc734b5c --- /dev/null +++ b/config/api-particulier-openapi-v3.yml @@ -0,0 +1,7254 @@ +--- +openapi: 3.0.0 +info: + title: API Particulier + version: 3.0.0 + description: | + ## Bienvenue sur la documentation interactive d'API Particulier. + + ### Commencer à utiliser l'API + + API Particulier est une API en accès restreint, ce qui signifie qu'il vous faut remplir une [demande d'habilitation](https://datapass.api.gouv.fr) avant de pouvoir l'utiliser avec des vraies données. + + Afin de tester l'API avant la validation de votre demande d'habilitation, nous avons mis en place un bac à sable de l'API qui reproduit les comportements de l'API en production. + + Dans cet environnement, les données sont fictives et éditables par tout le monde. Cet environnement essaye de simuler au mieux les compotements en production en fournissant des réponses à un ensemble de paramètre fixe. + Pour accéder à l'environnement de staging, référez-vous à la [documentation](https://particulier.api.gouv.fr/developpeurs#tester-api-preproduction). + + Le bac à sable et l'API de production sont appelables par deux adresses distinctes : + + - bac à sable : [https://staging.particulier.api.gouv.fr](https://staging.particulier.api.gouv.fr) + - production : [https://particulier.api.gouv.fr](https://particulier.api.gouv.fr) + + Pour récupérer le jeton de production un portail développeur est mis à votre disposition à l'adresse suivante : [https://particulier.api.gouv.fr/compte](https://particulier.api.gouv.fr/compte) + + Pour effectuer vos tests sur le bac à sable, référez-vous à ce dépôt github: [etalab/siade_staging_data](https://github.com/etalab/siade_staging_data/) (l'ancien système basé sur Airtable n'est plus maintenu et va être remplacé par le nouveau système). Un jeton nommé default est disponible ici: [tokens](https://github.com/etalab/siade_staging_data/tree/develop/tokens) + + ### Périmètre des données retournées + + **Important :** le contenu du jeu de données retourné dépend des _scopes_ ou _périmètres_ du jeton utilisé. + + En effet, les disposition de l'article [L144-8](https://www.legifrance.gouv.fr/codes/article_lc/LEGIARTI000045213315) n'autorisent que l'échange des informations **strictement nécessaires** pour traiter une démarche. + + Afin de respecter ce devoir de minimisation de la donnée, chaque jeton est associé, par la demande d'habilitation, à des _scopes_ agissant comme des masques sur la donnée. + + Ainsi, pour pouvoir lire de la donnée, il est nécessaire de cocher lors de votre [demande d'habilitation](https://datapass.api.gouv.fr) une ou plusieurs cases correspondant aux données du même fournisseur, votre jeton possèdera alors les _scopes_ associés aux données cochées. + + En conséquence, suivant le jeton utilisé, une même requête peut retourner des résultats différents. + + **Attention :** La documentation ci-dessous ne prend pas en compte les _scopes_, qui agissent comme masques de la donnée retournée par l'API. Cette documentation suppose donc que votre jeton permet d'accéder à la donnée décrite. + + ### Passer son service en production + + Lors de votre passage en production : + + - remplacez l'URL de staging.particulier.api.gouv.fr à particulier.api.gouv.fr + - remplacez le jeton de test par le jeton obtenu sur [le portail API Particulier](https://particulier.api.gouv.fr/compte) + termsOfService: https://api.gouv.fr/resources/CGU%20API%20Particulier.pdf + contact: + name: Contact API Particulier + email: api-particulier@api.gouv.fr + url: https://particulier.api.gouv.fr/ + license: + name: GNU Affero General Public License v3.0 + url: https://github.com/betagouv/api-particulier/blob/master/LICENSE +tags: [] +paths: + "/v3/dss/allocation_adulte_handicape/identite": + get: + summary: Statut allocation adulte handicapé (AAH) + tags: + - Statut Allocation Adulte Handicapé (AAH) + parameters: + - name: recipient + in: query + description: |- + "**Bénéficiaire de l’appel** + + SIRET de l’administration destinatrice des données." + example: '13002526500013' + required: true + schema: + type: string + - name: Cache-Control + in: header + description: Si cette valeur est fixée à "no-cache", le système de cache est + alors ignoré et la donnée est directement récupérée depuis le fournisseur + de données. + schema: + type: string + - name: nomNaissance + in: query + description: "**Nom de naissance, également appelé nom de famille**. \n\nLe + nom de naissance est indiqué sur l'acte de naissance, de mariage, sur le + livret de famille, etc. Le nom de famille/naissance figure toujours sur + la pièce d'identité en premier, avant le nom d'usage si le particulier en + a un. \n\nEn cas de changement de nom de naissance, une mention avec le + nouveau nom de famille est inscrite sur l'acte de naissance. Pour appeler + l'API, le nom de naissance/famille nécessaire est bien le nom de famille + modifié." + example: DURANT + required: true + schema: + type: string + - name: nomUsage + in: query + description: "**Nom d'usage**. \n\nSi le particulier a un nom d'usage, c'est + le nom qu'il utilise généralement au quotidien. Le nom d'usage est facultatif + et peut changer au cours de la vie. Il correspond au nom de famille/naissance + d'un parent, d'un époux ou d'une épouse, seul ou accolé au nom de famille/naissance. + Par exemple, le nom d'usage ne peut pas être le nom de famille/naissance + d'un concubin ou d'un partenaire de pacs. \n\nSi le particulier en a fait + la demande, le nom d'usage peut être inscrit derrière le nom de naissance + sur la carte d'identité ou le passeport ; il peut également être celui utilisé + par l'administration sur les courriers. Le nom d'usage ne remplace pas le + nom de famille/naissance qui reste le seul mentionné. \nDans nos APIs, le + nom d'usage n'est jamais identique au nom de famille.\n\nPour en savoir + plus : https://www.service-public.fr/particuliers/vosdroits/F868." + example: DUPONT DURANT + required: false + schema: + type: string + - name: prenoms[] + in: query + schema: + type: array + minItems: 1 + maxItems: 3 + items: + type: string + example: + - PIERRE + - RICHARD + description: "**Liste des prénoms**. \n\nFournir plusieurs prénoms maximise + les chances que l'API retrouve le particulier car cela permet de limiter + le risque d’homonymie." + required: true + - name: anneeDateNaissance + in: query + description: "**Année de naissance**. \n\nPour un particulier né en France, + dans le cadre d'un appel à l'API avec l'utilisation du paramètre 'nomCommuneNaissance', + ce paramètre est obligatoire (ainsi que le paramètre 'codeCogInseeDepartementNaissance') + afin de retrouver le code COG de la commune de naissance." + example: 1990 + required: false + schema: + type: integer + - name: moisDateNaissance + in: query + description: "**Mois de naissance**. \n\nCette valeur est ignorée si le paramètre + 'anneeDateNaissance' est vide." + example: 1 + required: false + schema: + type: integer + - name: jourDateNaissance + in: query + description: "**Jour de naissance**. \n\nCette valeur est ignorée si le paramètre + 'moisDateNaissance' ou le paramètre 'anneeDateNaissance' est vide.\"" + example: 1 + required: false + schema: + type: integer + - name: sexeEtatCivil + in: query + schema: + type: string + enum: + - M + - F + description: "**Sexe de la personne tel qu'indiqué sur les actes d'état civil**, + comme par exemple l'acte de naissance ou de mariage. \n\nDans la majorité + des cas, il s'agit également de la mention indiquée sur la pièce d'identité + et le passeport. Cette mention peut être masculin ('M') ou féminin ('F'). + \nDans le cas d'un particulier ayant demandé une modification de sa mention + de sexe à l'état civil, le changement est indiqué en marge de l'acte de + naissance une fois la décision rendue. Le changement intervient sur les + titres d'identité seulement si le particulier en demande le renouvellement." + example: M + required: true + - name: codeCogInseePaysNaissance + in: query + schema: + type: string + minLength: 5 + maxLength: 5 + example: '99100' + description: |- + **Code Insee à 5 chiffres du pays de naissance**. + + - Code Insee France = 99100 ; + - Liste de tous les codes Insee des pays étrangers depuis 1943 : https://explore.data.gouv.fr/fr/datasets/58c984b088ee386cdb1261f3/#/resources/150889d3-ffda-4ea5-8709-6ee67415294f. + required: true + - name: codeCogInseeCommuneNaissance + in: query + schema: + type: string + minLength: 5 + maxLength: 5 + example: '08480' + description: "**Code Insee à 5 chiffres de la commune de naissance**. \n\nPour + retrouver un particulier né en France, il est nécessaire d'indiquer sa commune + de naissance. Ce paramètre est une des deux options disponibles pour renseigner + la commune de naissance. En l'absence de l'utilisation de la seconde option + (triplet 'nomCommuneNaissance', 'anneeDateNaissance', 'codeInseeDepartementNaissance'), + ce paramètre est obligatoire si la personne est née en France.\n\nNe pas + remplir si la personne est née à l'étranger." + required: false + - name: nomCommuneNaissance + in: query + schema: + type: string + minLength: 1 + example: Gennevilliers + description: "**Nom en toute lettre de la commune de naissance**. \n\nPour + retrouver un particulier né en France, il est nécessaire d'indiquer sa commune + de naissance. Ce paramètre est une des deux options disponibles pour renseigner + la commune de naissance. En l'absence de l'utilisation du 'codeCogInseeCommuneNaissance', + ce paramètre est obligatoire si la personne est née en France ; il doit + être obligatoirement accompagné des paramètres 'codeCogInseeDepartementNaissance' + et 'anneeDateNaissance'.\n\nNe pas remplir si la personne est née à l'étranger." + required: false + - name: codeCogInseeDepartementNaissance + in: query + schema: + type: string + minLength: 2 + maxLength: 3 + example: '92' + description: "**Code INSEE du département de naissance**. \n\nPour retrouver + un particulier né en France, il est nécessaire d'indiquer sa commune de + naissance. Ce paramètre fait partie d'une des deux options disponibles pour + renseigner la commune de naissance. Lorsque le paramètre 'nomCommuneNaissance' + est utilisé, ce paramètre est obligatoire si la personne est née en France + et permet de retrouver le code COG avec le paramètre 'anneeDateNaissance'.\n\nNe + pas remplir si la personne est née à l'étranger." + required: false + security: + - jwt_bearer_token: [] + description: "Statut bénéficiaire de l'allocation adulte handicapé (AAH). \n\n + Retourne également des informations sur les dates d'ouverture des droits." + responses: + '401': + description: Non autorisé + content: + application/json: + examples: + invalid_token_error: + value: + errors: + - code: '00101' + title: Interdit + detail: Votre token n'est pas valide ou n'est pas renseigné + source: + parameter: token + meta: {} + summary: Interdit + description: Votre token n'est pas valide ou n'est pas renseigné + expired_token_error: + value: + errors: + - code: '00103' + title: Jeton expiré + detail: Votre token est expiré. Vous devez refaire une demande + source: + parameter: token + meta: {} + summary: Jeton expiré + description: Votre token est expiré. Vous devez refaire une demande + blacklisted_token_error: + value: + errors: + - code: '00105' + title: Jeton sur liste noire + detail: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver + un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + source: + parameter: token + meta: {} + summary: Jeton sur liste noire + description: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver un + jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + schema: + "$ref": "#/components/schemas/Error" + '403': + description: Accès interdit + content: + application/json: + examples: + insufficient_privileges_error: + value: + errors: + - code: '00100' + title: Privilèges insuffisants + detail: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + source: + parameter: token + meta: {} + summary: Privilèges insuffisants + description: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + schema: + "$ref": "#/components/schemas/Error" + '429': + description: Trop de requêtes + content: + application/json: + examples: + too_many_requests_error: + value: + errors: + - code: '00429' + title: Trop de requêtes + detail: Vous avez effectué trop de requêtes + source: + meta: {} + summary: Trop de requêtes + description: Vous avez effectué trop de requêtes + schema: + "$ref": "#/components/schemas/Error" + '200': + description: Allocation Adulte Handicape active trouvée + headers: + X-Response-Cached: + schema: + type: boolean + example: true + enum: + - true + - false + default: false + description: Indique si la réponse a été caché. + X-Cache-Expires-in: + schema: + type: number + nullable: true + example: 9001 + description: Secondes avant que le cache n'expire. Si le cache est vide, + ce header est vide (mais présent). La durée du cache est de 1 heure. + x-operationId: api_particulier_v3_cnav_allocation_adulte_handicape_with_civility + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + est_beneficiaire: + title: Statut bénéficiaire de l'allocation adulte handicapé + (AAH) + type: boolean + example: true + description: Indique que le particulier est bénéficiaire de + l'allocation adulte handicapé au moment de l'appel. + date_debut_droit: + title: Date d'ouverture du droit à l'AAH + type: string + nullable: true + description: "Date de début de droit à l'allocation adulte + handicapé du particulier bénéficiaire. \n Ce champs est + null dans le cas où le particulier n'est pas bénéficiaire + de l'AAH." + example: '1992-11-29' + required: + - est_beneficiaire + - date_debut_droit + additionalProperties: false + links: + type: object + meta: + type: object + required: + - data + - links + - meta + '404': + description: Dossier non trouvé + content: + application/json: + examples: + entite_non_trouvee_37003: + value: + errors: + - code: '37003' + title: Entité non trouvée + detail: Dossier allocataire inexistant. Le document ne peut + être édité. + source: + meta: + provider: CNAV + summary: Entité non trouvée + description: Dossier allocataire inexistant. Le document ne peut + être édité. + schema: + "$ref": "#/components/schemas/Error" + '502': + description: Erreur du fournisseur + content: + application/json: + examples: + provider_unknown_error: + value: + errors: + - code: '37999' + title: Erreur inconnue du fournisseur de données + detail: La réponse retournée par le fournisseur de données est + invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + source: + meta: + provider: CNAV + summary: Erreur inconnue du fournisseur de données + description: La réponse retournée par le fournisseur de données + est invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + schema: + "$ref": "#/components/schemas/Error" + '504': + description: Erreur d'intermédiaire + content: + application/json: + examples: + timeout_error: + value: + errors: + - code: '37002' + title: Intermédiaire hors-délai + detail: Temps d’attente d’une réponse du fournisseur de données + écoulé. + source: + meta: + provider: CNAV + summary: Intermédiaire hors-délai + description: Temps d’attente d’une réponse du fournisseur de données + écoulé. + provider_unavailable_error: + value: + errors: + - code: '37001' + title: Service non disponible + detail: Service du fournisseur de données temporairement indisponible + ou en maintenance. + source: + meta: + provider: CNAV + summary: Service non disponible + description: Service du fournisseur de données temporairement indisponible + ou en maintenance. + network_error: + value: + errors: + - code: '00501' + title: Erreur réseau + detail: Problème de connexion au serveur distant. L'erreur peut + venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + source: + meta: + retry_in: 10 + summary: Erreur réseau + description: Problème de connexion au serveur distant. L'erreur + peut venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + dns_resolution_error: + value: + errors: + - code: '37004' + title: Erreur de résolution DNS + detail: Problème de résolution DNS de l'adresse du serveur + source: + meta: + provider: CNAV + summary: Erreur de résolution DNS + description: Problème de résolution DNS de l'adresse du serveur + provider_error: + value: + errors: + - code: '37008' + title: 'Erreur auprès du fournisseur de données : trop de requêtes' + detail: 'Erreur de fournisseur de donnée : Trop de requêtes + effectuées, veuillez réessayer plus tard.' + source: + meta: + provider: CNAV + summary: 'Erreur auprès du fournisseur de données : trop de requêtes' + description: 'Erreur de fournisseur de donnée : Trop de requêtes + effectuées, veuillez réessayer plus tard.' + schema: + "$ref": "#/components/schemas/Error" + "/v3/dss/allocation_adulte_handicape/france_connect": + get: + summary: Statut allocation adulte handicapé (AAH) + tags: + - Statut Allocation Adulte Handicapé (AAH) + parameters: + - name: recipient + in: query + description: |- + "**Bénéficiaire de l’appel** + + SIRET de l’administration destinatrice des données." + example: '13002526500013' + required: true + schema: + type: string + security: + - jwt_bearer_token: [] + description: "Statut bénéficiaire de l'allocation adulte handicapé (AAH). \n\n + Retourne également des informations sur les dates d'ouverture des droits." + responses: + '403': + description: Accès interdit + content: + application/json: + examples: + insufficient_privileges_error: + value: + errors: + - code: '00100' + title: Privilèges insuffisants + detail: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + source: + parameter: token + meta: {} + summary: Privilèges insuffisants + description: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + schema: + "$ref": "#/components/schemas/Error" + '200': + description: Dossier trouvé + headers: + X-Response-Cached: + schema: + type: boolean + example: true + enum: + - true + - false + default: false + description: Indique si la réponse a été caché. + X-Cache-Expires-in: + schema: + type: number + nullable: true + example: 9001 + description: Secondes avant que le cache n'expire. Si le cache est vide, + ce header est vide (mais présent). La durée du cache est de 1 heure. + x-operationId: api_particulier_v3_cnav_allocation_adulte_handicape_with_france_connect + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + est_beneficiaire: + title: Statut bénéficiaire de l'allocation adulte handicapé + (AAH) + type: boolean + example: true + description: Indique que le particulier est bénéficiaire de + l'allocation adulte handicapé au moment de l'appel. + date_debut_droit: + title: Date d'ouverture du droit à l'AAH + type: string + nullable: true + description: "Date de début de droit à l'allocation adulte + handicapé du particulier bénéficiaire. \n Ce champs est + null dans le cas où le particulier n'est pas bénéficiaire + de l'AAH." + example: '1992-11-29' + required: + - est_beneficiaire + - date_debut_droit + additionalProperties: false + links: + type: object + meta: + type: object + required: + - data + - links + - meta + '404': + description: Dossier non trouvé + content: + application/json: + examples: + entite_non_trouvee_37003: + value: + errors: + - code: '37003' + title: Entité non trouvée + detail: Dossier allocataire inexistant. Le document ne peut + être édité. + source: + meta: + provider: CNAV + summary: Entité non trouvée + description: Dossier allocataire inexistant. Le document ne peut + être édité. + schema: + "$ref": "#/components/schemas/Error" + "/v3/dss/allocation_soutien_familial/identite": + get: + summary: Statut allocation de soutien familial (ASF) + tags: + - Statut Allocation Soutien Familial (ASF) + parameters: + - name: recipient + in: query + description: |- + "**Bénéficiaire de l’appel** + + SIRET de l’administration destinatrice des données." + example: '13002526500013' + required: true + schema: + type: string + - name: Cache-Control + in: header + description: Si cette valeur est fixée à "no-cache", le système de cache est + alors ignoré et la donnée est directement récupérée depuis le fournisseur + de données. + schema: + type: string + - name: nomNaissance + in: query + description: "**Nom de naissance, également appelé nom de famille**. \n\nLe + nom de naissance est indiqué sur l'acte de naissance, de mariage, sur le + livret de famille, etc. Le nom de famille/naissance figure toujours sur + la pièce d'identité en premier, avant le nom d'usage si le particulier en + a un. \n\nEn cas de changement de nom de naissance, une mention avec le + nouveau nom de famille est inscrite sur l'acte de naissance. Pour appeler + l'API, le nom de naissance/famille nécessaire est bien le nom de famille + modifié." + example: DURANT + required: true + schema: + type: string + - name: nomUsage + in: query + description: "**Nom d'usage**. \n\nSi le particulier a un nom d'usage, c'est + le nom qu'il utilise généralement au quotidien. Le nom d'usage est facultatif + et peut changer au cours de la vie. Il correspond au nom de famille/naissance + d'un parent, d'un époux ou d'une épouse, seul ou accolé au nom de famille/naissance. + Par exemple, le nom d'usage ne peut pas être le nom de famille/naissance + d'un concubin ou d'un partenaire de pacs. \n\nSi le particulier en a fait + la demande, le nom d'usage peut être inscrit derrière le nom de naissance + sur la carte d'identité ou le passeport ; il peut également être celui utilisé + par l'administration sur les courriers. Le nom d'usage ne remplace pas le + nom de famille/naissance qui reste le seul mentionné. \nDans nos APIs, le + nom d'usage n'est jamais identique au nom de famille.\n\nPour en savoir + plus : https://www.service-public.fr/particuliers/vosdroits/F868." + example: DUPONT DURANT + required: false + schema: + type: string + - name: prenoms[] + in: query + schema: + type: array + minItems: 1 + maxItems: 3 + items: + type: string + example: + - PIERRE + - RICHARD + description: "**Liste des prénoms**. \n\nFournir plusieurs prénoms maximise + les chances que l'API retrouve le particulier car cela permet de limiter + le risque d’homonymie." + required: true + - name: anneeDateNaissance + in: query + description: "**Année de naissance**. \n\nPour un particulier né en France, + dans le cadre d'un appel à l'API avec l'utilisation du paramètre 'nomCommuneNaissance', + ce paramètre est obligatoire (ainsi que le paramètre 'codeCogInseeDepartementNaissance') + afin de retrouver le code COG de la commune de naissance." + example: 1990 + required: false + schema: + type: integer + - name: moisDateNaissance + in: query + description: "**Mois de naissance**. \n\nCette valeur est ignorée si le paramètre + 'anneeDateNaissance' est vide." + example: 1 + required: false + schema: + type: integer + - name: jourDateNaissance + in: query + description: "**Jour de naissance**. \n\nCette valeur est ignorée si le paramètre + 'moisDateNaissance' ou le paramètre 'anneeDateNaissance' est vide.\"" + example: 1 + required: false + schema: + type: integer + - name: sexeEtatCivil + in: query + schema: + type: string + enum: + - M + - F + description: "**Sexe de la personne tel qu'indiqué sur les actes d'état civil**, + comme par exemple l'acte de naissance ou de mariage. \n\nDans la majorité + des cas, il s'agit également de la mention indiquée sur la pièce d'identité + et le passeport. Cette mention peut être masculin ('M') ou féminin ('F'). + \nDans le cas d'un particulier ayant demandé une modification de sa mention + de sexe à l'état civil, le changement est indiqué en marge de l'acte de + naissance une fois la décision rendue. Le changement intervient sur les + titres d'identité seulement si le particulier en demande le renouvellement." + example: M + required: true + - name: codeCogInseePaysNaissance + in: query + schema: + type: string + minLength: 5 + maxLength: 5 + example: '99100' + description: |- + **Code Insee à 5 chiffres du pays de naissance**. + + - Code Insee France = 99100 ; + - Liste de tous les codes Insee des pays étrangers depuis 1943 : https://explore.data.gouv.fr/fr/datasets/58c984b088ee386cdb1261f3/#/resources/150889d3-ffda-4ea5-8709-6ee67415294f. + required: true + - name: codeCogInseeCommuneNaissance + in: query + schema: + type: string + minLength: 5 + maxLength: 5 + example: '08480' + description: "**Code Insee à 5 chiffres de la commune de naissance**. \n\nPour + retrouver un particulier né en France, il est nécessaire d'indiquer sa commune + de naissance. Ce paramètre est une des deux options disponibles pour renseigner + la commune de naissance. En l'absence de l'utilisation de la seconde option + (triplet 'nomCommuneNaissance', 'anneeDateNaissance', 'codeInseeDepartementNaissance'), + ce paramètre est obligatoire si la personne est née en France.\n\nNe pas + remplir si la personne est née à l'étranger." + required: false + - name: nomCommuneNaissance + in: query + schema: + type: string + minLength: 1 + example: Gennevilliers + description: "**Nom en toute lettre de la commune de naissance**. \n\nPour + retrouver un particulier né en France, il est nécessaire d'indiquer sa commune + de naissance. Ce paramètre est une des deux options disponibles pour renseigner + la commune de naissance. En l'absence de l'utilisation du 'codeCogInseeCommuneNaissance', + ce paramètre est obligatoire si la personne est née en France ; il doit + être obligatoirement accompagné des paramètres 'codeCogInseeDepartementNaissance' + et 'anneeDateNaissance'.\n\nNe pas remplir si la personne est née à l'étranger." + required: false + - name: codeCogInseeDepartementNaissance + in: query + schema: + type: string + minLength: 2 + maxLength: 3 + example: '92' + description: "**Code INSEE du département de naissance**. \n\nPour retrouver + un particulier né en France, il est nécessaire d'indiquer sa commune de + naissance. Ce paramètre fait partie d'une des deux options disponibles pour + renseigner la commune de naissance. Lorsque le paramètre 'nomCommuneNaissance' + est utilisé, ce paramètre est obligatoire si la personne est née en France + et permet de retrouver le code COG avec le paramètre 'anneeDateNaissance'.\n\nNe + pas remplir si la personne est née à l'étranger." + required: false + security: + - jwt_bearer_token: [] + description: "Statut bénéficiaire de l'allocation de soutien familial (ASF). + \n\n Retourne également des informations sur les dates d'ouverture et de fermeture + des droits." + responses: + '401': + description: Non autorisé + content: + application/json: + examples: + invalid_token_error: + value: + errors: + - code: '00101' + title: Interdit + detail: Votre token n'est pas valide ou n'est pas renseigné + source: + parameter: token + meta: {} + summary: Interdit + description: Votre token n'est pas valide ou n'est pas renseigné + expired_token_error: + value: + errors: + - code: '00103' + title: Jeton expiré + detail: Votre token est expiré. Vous devez refaire une demande + source: + parameter: token + meta: {} + summary: Jeton expiré + description: Votre token est expiré. Vous devez refaire une demande + blacklisted_token_error: + value: + errors: + - code: '00105' + title: Jeton sur liste noire + detail: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver + un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + source: + parameter: token + meta: {} + summary: Jeton sur liste noire + description: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver un + jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + schema: + "$ref": "#/components/schemas/Error" + '403': + description: Accès interdit + content: + application/json: + examples: + insufficient_privileges_error: + value: + errors: + - code: '00100' + title: Privilèges insuffisants + detail: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + source: + parameter: token + meta: {} + summary: Privilèges insuffisants + description: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + schema: + "$ref": "#/components/schemas/Error" + '429': + description: Trop de requêtes + content: + application/json: + examples: + too_many_requests_error: + value: + errors: + - code: '00429' + title: Trop de requêtes + detail: Vous avez effectué trop de requêtes + source: + meta: {} + summary: Trop de requêtes + description: Vous avez effectué trop de requêtes + schema: + "$ref": "#/components/schemas/Error" + '200': + description: Allocation Soutien Familial active trouvée + headers: + X-Response-Cached: + schema: + type: boolean + example: true + enum: + - true + - false + default: false + description: Indique si la réponse a été caché. + X-Cache-Expires-in: + schema: + type: number + nullable: true + example: 9001 + description: Secondes avant que le cache n'expire. Si le cache est vide, + ce header est vide (mais présent). La durée du cache est de 1 heure. + x-operationId: api_particulier_v3_cnav_allocation_soutien_familial_with_civility + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + est_beneficiaire: + title: Statut bénéficiaire de l'allocation de soutien familial + (ASF) + type: boolean + example: true + description: Indique que le particulier est bénéficiaire de + l'allocation de soutien familial au moment de l'appel. + date_debut_droit: + title: Date d'ouverture du droit à l'ASF + type: string + nullable: true + description: "Date de début de droit à l'allocation de soutien + familial du particulier bénéficiaire. \n Ce champ est null + dans le cas où le particulier n'est pas bénéficiaire de + l'ASF." + example: '1992-11-29' + required: + - est_beneficiaire + - date_debut_droit + additionalProperties: false + links: + type: object + meta: + type: object + required: + - data + - links + - meta + '404': + description: Dossier non trouvé + content: + application/json: + examples: + entite_non_trouvee_37003: + value: + errors: + - code: '37003' + title: Entité non trouvée + detail: Dossier allocataire inexistant. Le document ne peut + être édité. + source: + meta: + provider: CNAV + summary: Entité non trouvée + description: Dossier allocataire inexistant. Le document ne peut + être édité. + schema: + "$ref": "#/components/schemas/Error" + '502': + description: Erreur du fournisseur + content: + application/json: + examples: + provider_unknown_error: + value: + errors: + - code: '37999' + title: Erreur inconnue du fournisseur de données + detail: La réponse retournée par le fournisseur de données est + invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + source: + meta: + provider: CNAV + summary: Erreur inconnue du fournisseur de données + description: La réponse retournée par le fournisseur de données + est invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + schema: + "$ref": "#/components/schemas/Error" + '504': + description: Erreur d'intermédiaire + content: + application/json: + examples: + timeout_error: + value: + errors: + - code: '37002' + title: Intermédiaire hors-délai + detail: Temps d’attente d’une réponse du fournisseur de données + écoulé. + source: + meta: + provider: CNAV + summary: Intermédiaire hors-délai + description: Temps d’attente d’une réponse du fournisseur de données + écoulé. + provider_unavailable_error: + value: + errors: + - code: '37001' + title: Service non disponible + detail: Service du fournisseur de données temporairement indisponible + ou en maintenance. + source: + meta: + provider: CNAV + summary: Service non disponible + description: Service du fournisseur de données temporairement indisponible + ou en maintenance. + network_error: + value: + errors: + - code: '00501' + title: Erreur réseau + detail: Problème de connexion au serveur distant. L'erreur peut + venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + source: + meta: + retry_in: 10 + summary: Erreur réseau + description: Problème de connexion au serveur distant. L'erreur + peut venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + dns_resolution_error: + value: + errors: + - code: '37004' + title: Erreur de résolution DNS + detail: Problème de résolution DNS de l'adresse du serveur + source: + meta: + provider: CNAV + summary: Erreur de résolution DNS + description: Problème de résolution DNS de l'adresse du serveur + provider_error: + value: + errors: + - code: '37008' + title: 'Erreur auprès du fournisseur de données : trop de requêtes' + detail: 'Erreur de fournisseur de donnée : Trop de requêtes + effectuées, veuillez réessayer plus tard.' + source: + meta: + provider: CNAV + summary: 'Erreur auprès du fournisseur de données : trop de requêtes' + description: 'Erreur de fournisseur de donnée : Trop de requêtes + effectuées, veuillez réessayer plus tard.' + schema: + "$ref": "#/components/schemas/Error" + "/v3/dss/allocation_soutien_familial/france_connect": + get: + summary: Statut allocation de soutien familial (ASF) + tags: + - Statut Allocation Soutien Familial (ASF) + parameters: + - name: recipient + in: query + description: |- + "**Bénéficiaire de l’appel** + + SIRET de l’administration destinatrice des données." + example: '13002526500013' + required: true + schema: + type: string + security: + - jwt_bearer_token: [] + description: "Statut bénéficiaire de l'allocation de soutien familial (ASF). + \n\n Retourne également des informations sur les dates d'ouverture et de fermeture + des droits." + responses: + '403': + description: Accès interdit + content: + application/json: + examples: + insufficient_privileges_error: + value: + errors: + - code: '00100' + title: Privilèges insuffisants + detail: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + source: + parameter: token + meta: {} + summary: Privilèges insuffisants + description: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + schema: + "$ref": "#/components/schemas/Error" + '200': + description: Dossier trouvé + headers: + X-Response-Cached: + schema: + type: boolean + example: true + enum: + - true + - false + default: false + description: Indique si la réponse a été caché. + X-Cache-Expires-in: + schema: + type: number + nullable: true + example: 9001 + description: Secondes avant que le cache n'expire. Si le cache est vide, + ce header est vide (mais présent). La durée du cache est de 1 heure. + x-operationId: api_particulier_v3_cnav_allocation_soutien_familial_with_france_connect + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + est_beneficiaire: + title: Statut bénéficiaire de l'allocation de soutien familial + (ASF) + type: boolean + example: true + description: Indique que le particulier est bénéficiaire de + l'allocation de soutien familial au moment de l'appel. + date_debut_droit: + title: Date d'ouverture du droit à l'ASF + type: string + nullable: true + description: "Date de début de droit à l'allocation de soutien + familial du particulier bénéficiaire. \n Ce champ est null + dans le cas où le particulier n'est pas bénéficiaire de + l'ASF." + example: '1992-11-29' + required: + - est_beneficiaire + - date_debut_droit + additionalProperties: false + links: + type: object + meta: + type: object + required: + - data + - links + - meta + '404': + description: Dossier non trouvé + content: + application/json: + examples: + entite_non_trouvee_37003: + value: + errors: + - code: '37003' + title: Entité non trouvée + detail: Dossier allocataire inexistant. Le document ne peut + être édité. + source: + meta: + provider: CNAV + summary: Entité non trouvée + description: Dossier allocataire inexistant. Le document ne peut + être édité. + schema: + "$ref": "#/components/schemas/Error" + "/v3/dss/complementaire_sante_solidaire/identite": + get: + summary: Statut complémentaire santé solidaire (C2S) + tags: + - Statut Complémentaire Santé Solidaire (C2S) + parameters: + - name: recipient + in: query + description: |- + "**Bénéficiaire de l’appel** + + SIRET de l’administration destinatrice des données." + example: '13002526500013' + required: true + schema: + type: string + - name: Cache-Control + in: header + description: Si cette valeur est fixée à "no-cache", le système de cache est + alors ignoré et la donnée est directement récupérée depuis le fournisseur + de données. + schema: + type: string + - name: nomNaissance + in: query + description: "**Nom de naissance, également appelé nom de famille**. \n\nLe + nom de naissance est indiqué sur l'acte de naissance, de mariage, sur le + livret de famille, etc. Le nom de famille/naissance figure toujours sur + la pièce d'identité en premier, avant le nom d'usage si le particulier en + a un. \n\nEn cas de changement de nom de naissance, une mention avec le + nouveau nom de famille est inscrite sur l'acte de naissance. Pour appeler + l'API, le nom de naissance/famille nécessaire est bien le nom de famille + modifié." + example: DURANT + required: true + schema: + type: string + - name: nomUsage + in: query + description: "**Nom d'usage**. \n\nSi le particulier a un nom d'usage, c'est + le nom qu'il utilise généralement au quotidien. Le nom d'usage est facultatif + et peut changer au cours de la vie. Il correspond au nom de famille/naissance + d'un parent, d'un époux ou d'une épouse, seul ou accolé au nom de famille/naissance. + Par exemple, le nom d'usage ne peut pas être le nom de famille/naissance + d'un concubin ou d'un partenaire de pacs. \n\nSi le particulier en a fait + la demande, le nom d'usage peut être inscrit derrière le nom de naissance + sur la carte d'identité ou le passeport ; il peut également être celui utilisé + par l'administration sur les courriers. Le nom d'usage ne remplace pas le + nom de famille/naissance qui reste le seul mentionné. \nDans nos APIs, le + nom d'usage n'est jamais identique au nom de famille.\n\nPour en savoir + plus : https://www.service-public.fr/particuliers/vosdroits/F868." + example: DUPONT DURANT + required: false + schema: + type: string + - name: prenoms[] + in: query + schema: + type: array + minItems: 1 + maxItems: 3 + items: + type: string + example: + - PIERRE + - RICHARD + description: "**Liste des prénoms**. \n\nFournir plusieurs prénoms maximise + les chances que l'API retrouve le particulier car cela permet de limiter + le risque d’homonymie." + required: true + - name: anneeDateNaissance + in: query + description: "**Année de naissance**. \n\nPour un particulier né en France, + dans le cadre d'un appel à l'API avec l'utilisation du paramètre 'nomCommuneNaissance', + ce paramètre est obligatoire (ainsi que le paramètre 'codeCogInseeDepartementNaissance') + afin de retrouver le code COG de la commune de naissance." + example: 1990 + required: false + schema: + type: integer + - name: moisDateNaissance + in: query + description: "**Mois de naissance**. \n\nCette valeur est ignorée si le paramètre + 'anneeDateNaissance' est vide." + example: 1 + required: false + schema: + type: integer + - name: jourDateNaissance + in: query + description: "**Jour de naissance**. \n\nCette valeur est ignorée si le paramètre + 'moisDateNaissance' ou le paramètre 'anneeDateNaissance' est vide.\"" + example: 1 + required: false + schema: + type: integer + - name: sexeEtatCivil + in: query + schema: + type: string + enum: + - M + - F + description: "**Sexe de la personne tel qu'indiqué sur les actes d'état civil**, + comme par exemple l'acte de naissance ou de mariage. \n\nDans la majorité + des cas, il s'agit également de la mention indiquée sur la pièce d'identité + et le passeport. Cette mention peut être masculin ('M') ou féminin ('F'). + \nDans le cas d'un particulier ayant demandé une modification de sa mention + de sexe à l'état civil, le changement est indiqué en marge de l'acte de + naissance une fois la décision rendue. Le changement intervient sur les + titres d'identité seulement si le particulier en demande le renouvellement." + example: M + required: true + - name: codeCogInseePaysNaissance + in: query + schema: + type: string + minLength: 5 + maxLength: 5 + example: '99100' + description: |- + **Code Insee à 5 chiffres du pays de naissance**. + + - Code Insee France = 99100 ; + - Liste de tous les codes Insee des pays étrangers depuis 1943 : https://explore.data.gouv.fr/fr/datasets/58c984b088ee386cdb1261f3/#/resources/150889d3-ffda-4ea5-8709-6ee67415294f. + required: true + - name: codeCogInseeCommuneNaissance + in: query + schema: + type: string + minLength: 5 + maxLength: 5 + example: '08480' + description: "**Code Insee à 5 chiffres de la commune de naissance**. \n\nPour + retrouver un particulier né en France, il est nécessaire d'indiquer sa commune + de naissance. Ce paramètre est une des deux options disponibles pour renseigner + la commune de naissance. En l'absence de l'utilisation de la seconde option + (triplet 'nomCommuneNaissance', 'anneeDateNaissance', 'codeInseeDepartementNaissance'), + ce paramètre est obligatoire si la personne est née en France.\n\nNe pas + remplir si la personne est née à l'étranger." + required: false + - name: nomCommuneNaissance + in: query + schema: + type: string + minLength: 1 + example: Gennevilliers + description: "**Nom en toute lettre de la commune de naissance**. \n\nPour + retrouver un particulier né en France, il est nécessaire d'indiquer sa commune + de naissance. Ce paramètre est une des deux options disponibles pour renseigner + la commune de naissance. En l'absence de l'utilisation du 'codeCogInseeCommuneNaissance', + ce paramètre est obligatoire si la personne est née en France ; il doit + être obligatoirement accompagné des paramètres 'codeCogInseeDepartementNaissance' + et 'anneeDateNaissance'.\n\nNe pas remplir si la personne est née à l'étranger." + required: false + - name: codeCogInseeDepartementNaissance + in: query + schema: + type: string + minLength: 2 + maxLength: 3 + example: '92' + description: "**Code INSEE du département de naissance**. \n\nPour retrouver + un particulier né en France, il est nécessaire d'indiquer sa commune de + naissance. Ce paramètre fait partie d'une des deux options disponibles pour + renseigner la commune de naissance. Lorsque le paramètre 'nomCommuneNaissance' + est utilisé, ce paramètre est obligatoire si la personne est née en France + et permet de retrouver le code COG avec le paramètre 'anneeDateNaissance'.\n\nNe + pas remplir si la personne est née à l'étranger." + required: false + security: + - jwt_bearer_token: [] + description: "Statut bénéficiaire de la complémentaire santé solidaire (C2S). + \n\n Retourne également des informations sur les dates d'ouverture des droits. + \n Pour plus d'informations sur cette API et obtenir un accès en avant-première, + veuillez contacter l'équipe API Particulier. \n **Données disponibles en bac + à sable :** [Liste de payloads de test](https://github.com/etalab/siade_staging_data/blob/develop/payloads/complementaire_sante_solidaire)" + responses: + '401': + description: Non autorisé + content: + application/json: + examples: + invalid_token_error: + value: + errors: + - code: '00101' + title: Interdit + detail: Votre token n'est pas valide ou n'est pas renseigné + source: + parameter: token + meta: {} + summary: Interdit + description: Votre token n'est pas valide ou n'est pas renseigné + expired_token_error: + value: + errors: + - code: '00103' + title: Jeton expiré + detail: Votre token est expiré. Vous devez refaire une demande + source: + parameter: token + meta: {} + summary: Jeton expiré + description: Votre token est expiré. Vous devez refaire une demande + blacklisted_token_error: + value: + errors: + - code: '00105' + title: Jeton sur liste noire + detail: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver + un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + source: + parameter: token + meta: {} + summary: Jeton sur liste noire + description: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver un + jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + schema: + "$ref": "#/components/schemas/Error" + '403': + description: Accès interdit + content: + application/json: + examples: + insufficient_privileges_error: + value: + errors: + - code: '00100' + title: Privilèges insuffisants + detail: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + source: + parameter: token + meta: {} + summary: Privilèges insuffisants + description: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + schema: + "$ref": "#/components/schemas/Error" + '429': + description: Trop de requêtes + content: + application/json: + examples: + too_many_requests_error: + value: + errors: + - code: '00429' + title: Trop de requêtes + detail: Vous avez effectué trop de requêtes + source: + meta: {} + summary: Trop de requêtes + description: Vous avez effectué trop de requêtes + schema: + "$ref": "#/components/schemas/Error" + '200': + description: Complementaire Sante Solidaire trouvée + headers: + X-Response-Cached: + schema: + type: boolean + example: true + enum: + - true + - false + default: false + description: Indique si la réponse a été caché. + X-Cache-Expires-in: + schema: + type: number + nullable: true + example: 9001 + description: Secondes avant que le cache n'expire. Si le cache est vide, + ce header est vide (mais présent). La durée du cache est de 1 heure. + x-operationId: api_particulier_v3_cnav_complementaire_sante_solidaire_with_civility + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + est_beneficiaire: + title: Statut bénéficiaire de la complémentaire de santé solidaire + (C2S) + type: boolean + example: true + description: Indique que le particulier est bénéficiaire de + la complémentaire de santé solidaire au moment de l'appel. + avec_participation: + title: C2S avec participation financière + type: boolean + example: false + nullable: true + description: "Indique que la C2S du particulier bénéficiaire + est avec participation financière. \n Si ce champ est à + false, cela signifie que la C2S est sans participation financière + de la part de l'allocataire. \n Ce champ est null dans le + cas où le particulier n'est pas bénéficiaire de la C2S." + date_debut_droit: + title: Date d'ouverture du droit à la C2S + type: string + nullable: true + description: "Date de début de droit à la complémentaire santé + solidaire du particulier bénéficiaire. \n Ce champ est null + dans le cas où le particulier n'est pas bénéficiaire de + la C2S." + example: '1992-11-29' + required: + - est_beneficiaire + - avec_participation + - date_debut_droit + additionalProperties: false + links: + type: object + meta: + type: object + required: + - data + - links + - meta + '404': + description: Dossier non trouvé + content: + application/json: + examples: + entite_non_trouvee_37003: + value: + errors: + - code: '37003' + title: Entité non trouvée + detail: Dossier allocataire inexistant. Le document ne peut + être édité. + source: + meta: + provider: CNAV + summary: Entité non trouvée + description: Dossier allocataire inexistant. Le document ne peut + être édité. + schema: + "$ref": "#/components/schemas/Error" + '502': + description: Erreur du fournisseur + content: + application/json: + examples: + provider_unknown_error: + value: + errors: + - code: '37999' + title: Erreur inconnue du fournisseur de données + detail: La réponse retournée par le fournisseur de données est + invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + source: + meta: + provider: CNAV + summary: Erreur inconnue du fournisseur de données + description: La réponse retournée par le fournisseur de données + est invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + schema: + "$ref": "#/components/schemas/Error" + '504': + description: Erreur d'intermédiaire + content: + application/json: + examples: + timeout_error: + value: + errors: + - code: '37002' + title: Intermédiaire hors-délai + detail: Temps d’attente d’une réponse du fournisseur de données + écoulé. + source: + meta: + provider: CNAV + summary: Intermédiaire hors-délai + description: Temps d’attente d’une réponse du fournisseur de données + écoulé. + provider_unavailable_error: + value: + errors: + - code: '37001' + title: Service non disponible + detail: Service du fournisseur de données temporairement indisponible + ou en maintenance. + source: + meta: + provider: CNAV + summary: Service non disponible + description: Service du fournisseur de données temporairement indisponible + ou en maintenance. + network_error: + value: + errors: + - code: '00501' + title: Erreur réseau + detail: Problème de connexion au serveur distant. L'erreur peut + venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + source: + meta: + retry_in: 10 + summary: Erreur réseau + description: Problème de connexion au serveur distant. L'erreur + peut venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + dns_resolution_error: + value: + errors: + - code: '37004' + title: Erreur de résolution DNS + detail: Problème de résolution DNS de l'adresse du serveur + source: + meta: + provider: CNAV + summary: Erreur de résolution DNS + description: Problème de résolution DNS de l'adresse du serveur + provider_error: + value: + errors: + - code: '37008' + title: 'Erreur auprès du fournisseur de données : trop de requêtes' + detail: 'Erreur de fournisseur de donnée : Trop de requêtes + effectuées, veuillez réessayer plus tard.' + source: + meta: + provider: CNAV + summary: 'Erreur auprès du fournisseur de données : trop de requêtes' + description: 'Erreur de fournisseur de donnée : Trop de requêtes + effectuées, veuillez réessayer plus tard.' + schema: + "$ref": "#/components/schemas/Error" + "/v3/dss/complementaire_sante_solidaire/france_connect": + get: + summary: Statut complémentaire santé solidaire (C2S) + tags: + - Statut Complémentaire Santé Solidaire (C2S) + parameters: + - name: recipient + in: query + description: |- + "**Bénéficiaire de l’appel** + + SIRET de l’administration destinatrice des données." + example: '13002526500013' + required: true + schema: + type: string + security: + - jwt_bearer_token: [] + description: "Statut bénéficiaire de la complémentaire santé solidaire (C2S). + \n\n Retourne également des informations sur les dates d'ouverture des droits. + \n Pour plus d'informations sur cette API et obtenir un accès en avant-première, + veuillez contacter l'équipe API Particulier. \n **Données disponibles en bac + à sable :** [Liste de payloads de test](https://github.com/etalab/siade_staging_data/blob/develop/payloads/complementaire_sante_solidaire)" + responses: + '403': + description: Accès interdit + content: + application/json: + examples: + insufficient_privileges_error: + value: + errors: + - code: '00100' + title: Privilèges insuffisants + detail: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + source: + parameter: token + meta: {} + summary: Privilèges insuffisants + description: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + schema: + "$ref": "#/components/schemas/Error" + '200': + description: Dossier trouvé + headers: + X-Response-Cached: + schema: + type: boolean + example: true + enum: + - true + - false + default: false + description: Indique si la réponse a été caché. + X-Cache-Expires-in: + schema: + type: number + nullable: true + example: 9001 + description: Secondes avant que le cache n'expire. Si le cache est vide, + ce header est vide (mais présent). La durée du cache est de 1 heure. + x-operationId: api_particulier_v3_cnav_complementaire_sante_solidaire_with_france_connect + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + est_beneficiaire: + title: Statut bénéficiaire de la complémentaire de santé solidaire + (C2S) + type: boolean + example: true + description: Indique que le particulier est bénéficiaire de + la complémentaire de santé solidaire au moment de l'appel. + avec_participation: + title: C2S avec participation financière + type: boolean + example: false + nullable: true + description: "Indique que la C2S du particulier bénéficiaire + est avec participation financière. \n Si ce champ est à + false, cela signifie que la C2S est sans participation financière + de la part de l'allocataire. \n Ce champ est null dans le + cas où le particulier n'est pas bénéficiaire de la C2S." + date_debut_droit: + title: Date d'ouverture du droit à la C2S + type: string + nullable: true + description: "Date de début de droit à la complémentaire santé + solidaire du particulier bénéficiaire. \n Ce champ est null + dans le cas où le particulier n'est pas bénéficiaire de + la C2S." + example: '1992-11-29' + required: + - est_beneficiaire + - avec_participation + - date_debut_droit + additionalProperties: false + links: + type: object + meta: + type: object + required: + - data + - links + - meta + '404': + description: Dossier non trouvé + content: + application/json: + examples: + entite_non_trouvee_37003: + value: + errors: + - code: '37003' + title: Entité non trouvée + detail: Dossier allocataire inexistant. Le document ne peut + être édité. + source: + meta: + provider: CNAV + summary: Entité non trouvée + description: Dossier allocataire inexistant. Le document ne peut + être édité. + schema: + "$ref": "#/components/schemas/Error" + "/v3/dss/prime_activite/identite": + get: + summary: Statut prime d'activité + tags: + - Statut Prime Activité + parameters: + - name: recipient + in: query + description: |- + "**Bénéficiaire de l’appel** + + SIRET de l’administration destinatrice des données." + example: '13002526500013' + required: true + schema: + type: string + - name: Cache-Control + in: header + description: Si cette valeur est fixée à "no-cache", le système de cache est + alors ignoré et la donnée est directement récupérée depuis le fournisseur + de données. + schema: + type: string + - name: nomNaissance + in: query + description: "**Nom de naissance, également appelé nom de famille**. \n\nLe + nom de naissance est indiqué sur l'acte de naissance, de mariage, sur le + livret de famille, etc. Le nom de famille/naissance figure toujours sur + la pièce d'identité en premier, avant le nom d'usage si le particulier en + a un. \n\nEn cas de changement de nom de naissance, une mention avec le + nouveau nom de famille est inscrite sur l'acte de naissance. Pour appeler + l'API, le nom de naissance/famille nécessaire est bien le nom de famille + modifié." + example: DURANT + required: true + schema: + type: string + - name: nomUsage + in: query + description: "**Nom d'usage**. \n\nSi le particulier a un nom d'usage, c'est + le nom qu'il utilise généralement au quotidien. Le nom d'usage est facultatif + et peut changer au cours de la vie. Il correspond au nom de famille/naissance + d'un parent, d'un époux ou d'une épouse, seul ou accolé au nom de famille/naissance. + Par exemple, le nom d'usage ne peut pas être le nom de famille/naissance + d'un concubin ou d'un partenaire de pacs. \n\nSi le particulier en a fait + la demande, le nom d'usage peut être inscrit derrière le nom de naissance + sur la carte d'identité ou le passeport ; il peut également être celui utilisé + par l'administration sur les courriers. Le nom d'usage ne remplace pas le + nom de famille/naissance qui reste le seul mentionné. \nDans nos APIs, le + nom d'usage n'est jamais identique au nom de famille.\n\nPour en savoir + plus : https://www.service-public.fr/particuliers/vosdroits/F868." + example: DUPONT DURANT + required: false + schema: + type: string + - name: prenoms[] + in: query + schema: + type: array + minItems: 1 + maxItems: 3 + items: + type: string + example: + - PIERRE + - RICHARD + description: "**Liste des prénoms**. \n\nFournir plusieurs prénoms maximise + les chances que l'API retrouve le particulier car cela permet de limiter + le risque d’homonymie." + required: true + - name: anneeDateNaissance + in: query + description: "**Année de naissance**. \n\nPour un particulier né en France, + dans le cadre d'un appel à l'API avec l'utilisation du paramètre 'nomCommuneNaissance', + ce paramètre est obligatoire (ainsi que le paramètre 'codeCogInseeDepartementNaissance') + afin de retrouver le code COG de la commune de naissance." + example: 1990 + required: false + schema: + type: integer + - name: moisDateNaissance + in: query + description: "**Mois de naissance**. \n\nCette valeur est ignorée si le paramètre + 'anneeDateNaissance' est vide." + example: 1 + required: false + schema: + type: integer + - name: jourDateNaissance + in: query + description: "**Jour de naissance**. \n\nCette valeur est ignorée si le paramètre + 'moisDateNaissance' ou le paramètre 'anneeDateNaissance' est vide.\"" + example: 1 + required: false + schema: + type: integer + - name: sexeEtatCivil + in: query + schema: + type: string + enum: + - M + - F + description: "**Sexe de la personne tel qu'indiqué sur les actes d'état civil**, + comme par exemple l'acte de naissance ou de mariage. \n\nDans la majorité + des cas, il s'agit également de la mention indiquée sur la pièce d'identité + et le passeport. Cette mention peut être masculin ('M') ou féminin ('F'). + \nDans le cas d'un particulier ayant demandé une modification de sa mention + de sexe à l'état civil, le changement est indiqué en marge de l'acte de + naissance une fois la décision rendue. Le changement intervient sur les + titres d'identité seulement si le particulier en demande le renouvellement." + example: M + required: true + - name: codeCogInseePaysNaissance + in: query + schema: + type: string + minLength: 5 + maxLength: 5 + example: '99100' + description: |- + **Code Insee à 5 chiffres du pays de naissance**. + + - Code Insee France = 99100 ; + - Liste de tous les codes Insee des pays étrangers depuis 1943 : https://explore.data.gouv.fr/fr/datasets/58c984b088ee386cdb1261f3/#/resources/150889d3-ffda-4ea5-8709-6ee67415294f. + required: true + - name: codeCogInseeCommuneNaissance + in: query + schema: + type: string + minLength: 5 + maxLength: 5 + example: '08480' + description: "**Code Insee à 5 chiffres de la commune de naissance**. \n\nPour + retrouver un particulier né en France, il est nécessaire d'indiquer sa commune + de naissance. Ce paramètre est une des deux options disponibles pour renseigner + la commune de naissance. En l'absence de l'utilisation de la seconde option + (triplet 'nomCommuneNaissance', 'anneeDateNaissance', 'codeInseeDepartementNaissance'), + ce paramètre est obligatoire si la personne est née en France.\n\nNe pas + remplir si la personne est née à l'étranger." + required: false + - name: nomCommuneNaissance + in: query + schema: + type: string + minLength: 1 + example: Gennevilliers + description: "**Nom en toute lettre de la commune de naissance**. \n\nPour + retrouver un particulier né en France, il est nécessaire d'indiquer sa commune + de naissance. Ce paramètre est une des deux options disponibles pour renseigner + la commune de naissance. En l'absence de l'utilisation du 'codeCogInseeCommuneNaissance', + ce paramètre est obligatoire si la personne est née en France ; il doit + être obligatoirement accompagné des paramètres 'codeCogInseeDepartementNaissance' + et 'anneeDateNaissance'.\n\nNe pas remplir si la personne est née à l'étranger." + required: false + - name: codeCogInseeDepartementNaissance + in: query + schema: + type: string + minLength: 2 + maxLength: 3 + example: '92' + description: "**Code INSEE du département de naissance**. \n\nPour retrouver + un particulier né en France, il est nécessaire d'indiquer sa commune de + naissance. Ce paramètre fait partie d'une des deux options disponibles pour + renseigner la commune de naissance. Lorsque le paramètre 'nomCommuneNaissance' + est utilisé, ce paramètre est obligatoire si la personne est née en France + et permet de retrouver le code COG avec le paramètre 'anneeDateNaissance'.\n\nNe + pas remplir si la personne est née à l'étranger." + required: false + security: + - jwt_bearer_token: [] + description: "Statut bénéficiaire de la prime d'activité, majorée ou non. \n\n + Retourne également des informations sur les dates d'ouverture des droits." + responses: + '401': + description: Non autorisé + content: + application/json: + examples: + invalid_token_error: + value: + errors: + - code: '00101' + title: Interdit + detail: Votre token n'est pas valide ou n'est pas renseigné + source: + parameter: token + meta: {} + summary: Interdit + description: Votre token n'est pas valide ou n'est pas renseigné + expired_token_error: + value: + errors: + - code: '00103' + title: Jeton expiré + detail: Votre token est expiré. Vous devez refaire une demande + source: + parameter: token + meta: {} + summary: Jeton expiré + description: Votre token est expiré. Vous devez refaire une demande + blacklisted_token_error: + value: + errors: + - code: '00105' + title: Jeton sur liste noire + detail: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver + un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + source: + parameter: token + meta: {} + summary: Jeton sur liste noire + description: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver un + jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + schema: + "$ref": "#/components/schemas/Error" + '403': + description: Accès interdit + content: + application/json: + examples: + insufficient_privileges_error: + value: + errors: + - code: '00100' + title: Privilèges insuffisants + detail: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + source: + parameter: token + meta: {} + summary: Privilèges insuffisants + description: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + schema: + "$ref": "#/components/schemas/Error" + '429': + description: Trop de requêtes + content: + application/json: + examples: + too_many_requests_error: + value: + errors: + - code: '00429' + title: Trop de requêtes + detail: Vous avez effectué trop de requêtes + source: + meta: {} + summary: Trop de requêtes + description: Vous avez effectué trop de requêtes + schema: + "$ref": "#/components/schemas/Error" + '200': + description: Prime Activite active trouvée + headers: + X-Response-Cached: + schema: + type: boolean + example: true + enum: + - true + - false + default: false + description: Indique si la réponse a été caché. + X-Cache-Expires-in: + schema: + type: number + nullable: true + example: 9001 + description: Secondes avant que le cache n'expire. Si le cache est vide, + ce header est vide (mais présent). La durée du cache est de 1 heure. + x-operationId: api_particulier_v3_cnav_prime_activite_with_civility + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + est_beneficiaire: + title: Statut bénéficiaire de la prime d'activité + type: boolean + example: true + description: Indique que le particulier est bénéficiaire de + la prime d'activité au moment de l'appel. + avec_majoration: + title: Prime d'activité majorée + type: boolean + nullable: true + description: "Indique que la prime d'activité du particulier + bénéficiaire est majorée au moment de l'appel. \n Si ce + champ est à false, cela signifie que la prime d'activité + n'est pas majorée. \n Ce champ sera null si le particulier + n'est pas bénéficiaire de la prime d'activité." + example: false + date_debut_droit: + title: Date d'ouverture du droit à la prime d'activité + type: string + nullable: true + description: "Date de début de droit à la prime d'activité + si le particulier est bénéficiaire. \n Ce champ est null + dans le cas où le particulier n'est pas bénéficiaire de + la prime d'activité." + example: '1992-11-20' + required: + - est_beneficiaire + - avec_majoration + - date_debut_droit + additionalProperties: false + links: + type: object + meta: + type: object + required: + - data + - links + - meta + '404': + description: Dossier non trouvé + content: + application/json: + examples: + entite_non_trouvee_37003: + value: + errors: + - code: '37003' + title: Entité non trouvée + detail: Dossier allocataire inexistant. Le document ne peut + être édité. + source: + meta: + provider: CNAV + summary: Entité non trouvée + description: Dossier allocataire inexistant. Le document ne peut + être édité. + schema: + "$ref": "#/components/schemas/Error" + '502': + description: Erreur du fournisseur + content: + application/json: + examples: + provider_unknown_error: + value: + errors: + - code: '37999' + title: Erreur inconnue du fournisseur de données + detail: La réponse retournée par le fournisseur de données est + invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + source: + meta: + provider: CNAV + summary: Erreur inconnue du fournisseur de données + description: La réponse retournée par le fournisseur de données + est invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + schema: + "$ref": "#/components/schemas/Error" + '504': + description: Erreur d'intermédiaire + content: + application/json: + examples: + timeout_error: + value: + errors: + - code: '37002' + title: Intermédiaire hors-délai + detail: Temps d’attente d’une réponse du fournisseur de données + écoulé. + source: + meta: + provider: CNAV + summary: Intermédiaire hors-délai + description: Temps d’attente d’une réponse du fournisseur de données + écoulé. + provider_unavailable_error: + value: + errors: + - code: '37001' + title: Service non disponible + detail: Service du fournisseur de données temporairement indisponible + ou en maintenance. + source: + meta: + provider: CNAV + summary: Service non disponible + description: Service du fournisseur de données temporairement indisponible + ou en maintenance. + network_error: + value: + errors: + - code: '00501' + title: Erreur réseau + detail: Problème de connexion au serveur distant. L'erreur peut + venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + source: + meta: + retry_in: 10 + summary: Erreur réseau + description: Problème de connexion au serveur distant. L'erreur + peut venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + dns_resolution_error: + value: + errors: + - code: '37004' + title: Erreur de résolution DNS + detail: Problème de résolution DNS de l'adresse du serveur + source: + meta: + provider: CNAV + summary: Erreur de résolution DNS + description: Problème de résolution DNS de l'adresse du serveur + provider_error: + value: + errors: + - code: '37008' + title: 'Erreur auprès du fournisseur de données : trop de requêtes' + detail: 'Erreur de fournisseur de donnée : Trop de requêtes + effectuées, veuillez réessayer plus tard.' + source: + meta: + provider: CNAV + summary: 'Erreur auprès du fournisseur de données : trop de requêtes' + description: 'Erreur de fournisseur de donnée : Trop de requêtes + effectuées, veuillez réessayer plus tard.' + schema: + "$ref": "#/components/schemas/Error" + "/v3/dss/prime_activite/france_connect": + get: + summary: Statut prime d'activité + tags: + - Statut Prime Activité + parameters: + - name: recipient + in: query + description: |- + "**Bénéficiaire de l’appel** + + SIRET de l’administration destinatrice des données." + example: '13002526500013' + required: true + schema: + type: string + security: + - jwt_bearer_token: [] + description: "Statut bénéficiaire de la prime d'activité, majorée ou non. \n\n + Retourne également des informations sur les dates d'ouverture des droits." + responses: + '403': + description: Accès interdit + content: + application/json: + examples: + insufficient_privileges_error: + value: + errors: + - code: '00100' + title: Privilèges insuffisants + detail: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + source: + parameter: token + meta: {} + summary: Privilèges insuffisants + description: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + schema: + "$ref": "#/components/schemas/Error" + '200': + description: Dossier trouvé + headers: + X-Response-Cached: + schema: + type: boolean + example: true + enum: + - true + - false + default: false + description: Indique si la réponse a été caché. + X-Cache-Expires-in: + schema: + type: number + nullable: true + example: 9001 + description: Secondes avant que le cache n'expire. Si le cache est vide, + ce header est vide (mais présent). La durée du cache est de 1 heure. + x-operationId: api_particulier_v3_cnav_prime_activite_with_france_connect + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + est_beneficiaire: + title: Statut bénéficiaire de la prime d'activité + type: boolean + example: true + description: Indique que le particulier est bénéficiaire de + la prime d'activité au moment de l'appel. + avec_majoration: + title: Prime d'activité majorée + type: boolean + nullable: true + description: "Indique que la prime d'activité du particulier + bénéficiaire est majorée au moment de l'appel. \n Si ce + champ est à false, cela signifie que la prime d'activité + n'est pas majorée. \n Ce champ sera null si le particulier + n'est pas bénéficiaire de la prime d'activité." + example: false + date_debut_droit: + title: Date d'ouverture du droit à la prime d'activité + type: string + nullable: true + description: "Date de début de droit à la prime d'activité + si le particulier est bénéficiaire. \n Ce champ est null + dans le cas où le particulier n'est pas bénéficiaire de + la prime d'activité." + example: '1992-11-20' + required: + - est_beneficiaire + - avec_majoration + - date_debut_droit + additionalProperties: false + links: + type: object + meta: + type: object + required: + - data + - links + - meta + '404': + description: Dossier non trouvé + content: + application/json: + examples: + entite_non_trouvee_37003: + value: + errors: + - code: '37003' + title: Entité non trouvée + detail: Dossier allocataire inexistant. Le document ne peut + être édité. + source: + meta: + provider: CNAV + summary: Entité non trouvée + description: Dossier allocataire inexistant. Le document ne peut + être édité. + schema: + "$ref": "#/components/schemas/Error" + "/v3/dss/quotient_familial/identite": + get: + summary: Quotient familial CAF & MSA + tags: + - Quotient familial CAF & MSA + parameters: + - name: recipient + in: query + description: |- + "**Bénéficiaire de l’appel** + + SIRET de l’administration destinatrice des données." + example: '13002526500013' + required: true + schema: + type: string + - name: Cache-Control + in: header + description: Si cette valeur est fixée à "no-cache", le système de cache est + alors ignoré et la donnée est directement récupérée depuis le fournisseur + de données. + schema: + type: string + - name: nomNaissance + in: query + description: "**Nom de naissance, également appelé nom de famille**. \n\nLe + nom de naissance est indiqué sur l'acte de naissance, de mariage, sur le + livret de famille, etc. Le nom de famille/naissance figure toujours sur + la pièce d'identité en premier, avant le nom d'usage si le particulier en + a un. \n\nEn cas de changement de nom de naissance, une mention avec le + nouveau nom de famille est inscrite sur l'acte de naissance. Pour appeler + l'API, le nom de naissance/famille nécessaire est bien le nom de famille + modifié." + example: DURANT + required: true + schema: + type: string + - name: nomUsage + in: query + description: "**Nom d'usage**. \n\nSi le particulier a un nom d'usage, c'est + le nom qu'il utilise généralement au quotidien. Le nom d'usage est facultatif + et peut changer au cours de la vie. Il correspond au nom de famille/naissance + d'un parent, d'un époux ou d'une épouse, seul ou accolé au nom de famille/naissance. + Par exemple, le nom d'usage ne peut pas être le nom de famille/naissance + d'un concubin ou d'un partenaire de pacs. \n\nSi le particulier en a fait + la demande, le nom d'usage peut être inscrit derrière le nom de naissance + sur la carte d'identité ou le passeport ; il peut également être celui utilisé + par l'administration sur les courriers. Le nom d'usage ne remplace pas le + nom de famille/naissance qui reste le seul mentionné. \nDans nos APIs, le + nom d'usage n'est jamais identique au nom de famille.\n\nPour en savoir + plus : https://www.service-public.fr/particuliers/vosdroits/F868." + example: DUPONT DURANT + required: false + schema: + type: string + - name: prenoms[] + in: query + schema: + type: array + minItems: 1 + maxItems: 3 + items: + type: string + example: + - PIERRE + - RICHARD + description: "**Liste des prénoms**. \n\nFournir plusieurs prénoms maximise + les chances que l'API retrouve le particulier car cela permet de limiter + le risque d’homonymie." + required: true + - name: anneeDateNaissance + in: query + description: "**Année de naissance**. \n\nPour un particulier né en France, + dans le cadre d'un appel à l'API avec l'utilisation du paramètre 'nomCommuneNaissance', + ce paramètre est obligatoire (ainsi que le paramètre 'codeCogInseeDepartementNaissance') + afin de retrouver le code COG de la commune de naissance." + example: 1990 + required: false + schema: + type: integer + - name: moisDateNaissance + in: query + description: "**Mois de naissance**. \n\nCette valeur est ignorée si le paramètre + 'anneeDateNaissance' est vide." + example: 1 + required: false + schema: + type: integer + - name: jourDateNaissance + in: query + description: "**Jour de naissance**. \n\nCette valeur est ignorée si le paramètre + 'moisDateNaissance' ou le paramètre 'anneeDateNaissance' est vide.\"" + example: 1 + required: false + schema: + type: integer + - name: sexeEtatCivil + in: query + schema: + type: string + enum: + - M + - F + description: "**Sexe de la personne tel qu'indiqué sur les actes d'état civil**, + comme par exemple l'acte de naissance ou de mariage. \n\nDans la majorité + des cas, il s'agit également de la mention indiquée sur la pièce d'identité + et le passeport. Cette mention peut être masculin ('M') ou féminin ('F'). + \nDans le cas d'un particulier ayant demandé une modification de sa mention + de sexe à l'état civil, le changement est indiqué en marge de l'acte de + naissance une fois la décision rendue. Le changement intervient sur les + titres d'identité seulement si le particulier en demande le renouvellement." + example: M + required: true + - name: codeCogInseePaysNaissance + in: query + schema: + type: string + minLength: 5 + maxLength: 5 + example: '99100' + description: |- + **Code Insee à 5 chiffres du pays de naissance**. + + - Code Insee France = 99100 ; + - Liste de tous les codes Insee des pays étrangers depuis 1943 : https://explore.data.gouv.fr/fr/datasets/58c984b088ee386cdb1261f3/#/resources/150889d3-ffda-4ea5-8709-6ee67415294f. + required: true + - name: codeCogInseeCommuneNaissance + in: query + schema: + type: string + minLength: 5 + maxLength: 5 + example: '08480' + description: "**Code Insee à 5 chiffres de la commune de naissance**. \n\nPour + retrouver un particulier né en France, il est nécessaire d'indiquer sa commune + de naissance. Ce paramètre est une des deux options disponibles pour renseigner + la commune de naissance. En l'absence de l'utilisation de la seconde option + (triplet 'nomCommuneNaissance', 'anneeDateNaissance', 'codeInseeDepartementNaissance'), + ce paramètre est obligatoire si la personne est née en France.\n\nNe pas + remplir si la personne est née à l'étranger." + required: false + - name: nomCommuneNaissance + in: query + schema: + type: string + minLength: 1 + example: Gennevilliers + description: "**Nom en toute lettre de la commune de naissance**. \n\nPour + retrouver un particulier né en France, il est nécessaire d'indiquer sa commune + de naissance. Ce paramètre est une des deux options disponibles pour renseigner + la commune de naissance. En l'absence de l'utilisation du 'codeCogInseeCommuneNaissance', + ce paramètre est obligatoire si la personne est née en France ; il doit + être obligatoirement accompagné des paramètres 'codeCogInseeDepartementNaissance' + et 'anneeDateNaissance'.\n\nNe pas remplir si la personne est née à l'étranger." + required: false + - name: codeCogInseeDepartementNaissance + in: query + schema: + type: string + minLength: 2 + maxLength: 3 + example: '92' + description: "**Code INSEE du département de naissance**. \n\nPour retrouver + un particulier né en France, il est nécessaire d'indiquer sa commune de + naissance. Ce paramètre fait partie d'une des deux options disponibles pour + renseigner la commune de naissance. Lorsque le paramètre 'nomCommuneNaissance' + est utilisé, ce paramètre est obligatoire si la personne est née en France + et permet de retrouver le code COG avec le paramètre 'anneeDateNaissance'.\n\nNe + pas remplir si la personne est née à l'étranger." + required: false + security: + - jwt_bearer_token: [] + description: "Quotient familial délivré par la CAF ou la MSA et composition + de la famille de l'allocataire. \n Pour plus d'informations sur cette API + et obtenir un accès en avant-première, veuillez contacter l'équipe API Particulier. + \n **Données disponibles en bac à sable :** [liste](https://github.com/etalab/siade_staging_data/blob/develop/payloads/api_particulier_v2_cnav_quotient_familial_v2)" + responses: + '401': + description: Non autorisé + content: + application/json: + examples: + invalid_token_error: + value: + errors: + - code: '00101' + title: Interdit + detail: Votre token n'est pas valide ou n'est pas renseigné + source: + parameter: token + meta: {} + summary: Interdit + description: Votre token n'est pas valide ou n'est pas renseigné + expired_token_error: + value: + errors: + - code: '00103' + title: Jeton expiré + detail: Votre token est expiré. Vous devez refaire une demande + source: + parameter: token + meta: {} + summary: Jeton expiré + description: Votre token est expiré. Vous devez refaire une demande + blacklisted_token_error: + value: + errors: + - code: '00105' + title: Jeton sur liste noire + detail: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver + un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + source: + parameter: token + meta: {} + summary: Jeton sur liste noire + description: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver un + jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + schema: + "$ref": "#/components/schemas/Error" + '403': + description: Accès interdit + content: + application/json: + examples: + insufficient_privileges_error: + value: + errors: + - code: '00100' + title: Privilèges insuffisants + detail: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + source: + parameter: token + meta: {} + summary: Privilèges insuffisants + description: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + schema: + "$ref": "#/components/schemas/Error" + '429': + description: Trop de requêtes + content: + application/json: + examples: + too_many_requests_error: + value: + errors: + - code: '00429' + title: Trop de requêtes + detail: Vous avez effectué trop de requêtes + source: + meta: {} + summary: Trop de requêtes + description: Vous avez effectué trop de requêtes + schema: + "$ref": "#/components/schemas/Error" + '200': + description: Quotient Familial active trouvée + headers: + X-Response-Cached: + schema: + type: boolean + example: true + enum: + - true + - false + default: false + description: Indique si la réponse a été caché. + X-Cache-Expires-in: + schema: + type: number + nullable: true + example: 9001 + description: Secondes avant que le cache n'expire. Si le cache est vide, + ce header est vide (mais présent). La durée du cache est de 24 heure. + x-operationId: api_particulier_v3_cnav_quotient_familial_with_civility + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + allocataires: + title: Données d'identité de l'allocataire et du conjoint + type: array + minItems: 1 + description: Liste des données d'identité de l'allocataire + appelé et de celles du conjoint le cas échéant. La provenance + de ces données n'est pas sourcée précisément et diffère + selon la CAF ou la MSA. + items: + type: object + properties: + nom_naissance: + title: Nom + type: string + description: Nom de naissance de l'allocataire ou du + conjoint. + example: JACQUES + nom_usage: + title: Nom d'usage + type: string + description: Nom d'usage de l'allocataire ou du conjoint. + example: DUPONT + nullable: true + prenoms: + title: Prénoms + type: string + description: Prénoms de l'allocataire ou du conjoint. + example: JEAN-PIERRE THOMAS + date_naissance: + title: Date de naissance + description: Date de naissance de l'allocataire ou du + conjoint au format AAAA-MM-JJ. + type: string + example: '2000-01-20' + sexe: + title: Sexe + type: string + description: Sexe de l'allocataire ou du conjoint. + example: M + enum: + - F + - M + enfants: + type: array + title: Données d'identité des enfants composant la famille + description: Liste des données d'identité des enfants composant + la famille, le cas échéant. La provenance de ces données + n'est pas sourcée précisément et diffère selon la CAF ou + la MSA. + items: + type: object + properties: + nom_naissance: + title: Nom de naissance + type: string + description: Nom de naissance de l'enfant. + example: DUPONT + nom_usage: + title: Nom d'usage + type: string + description: Nom d'usage de l'enfant. + example: + nullable: true + prenoms: + title: Prénoms + type: string + description: Prénoms de l'enfant. + example: JEAN-PIERRE THOMAS JUNIOR + date_naissance: + title: Date de naissance + description: Date de naissance de l'enfant au format + AAAA-MM-JJ. + type: string + example: '2000-01-20' + sexe: + title: Sexe + type: string + description: Sexe de l'enfant. + example: M + enum: + - F + - M + adresse: + title: Adresse de la famille + type: object + description: Adresse de la famille au format de la poste. + properties: + destinataire: + title: Identité du destinataire + type: string + example: Monsieur JEAN JACQUES + description: 'Identité du destinataire : Civilité, titre + ou qualité + nom et prénom' + complement_information: + title: Complément d'information du destinataire ou point + de remise + type: string + nullable: true + example: + complement_information_geographique: + title: Complément d'information du point géographique + type: string + nullable: true + example: + numero_libelle_voie: + title: Voie + type: string + description: Numéro et libellé de la voie. + example: 1 RUE DE LA GARE + nullable: true + lieu_dit: + title: Lieu-dit + type: string + nullable: true + example: + description: 'Lieu-dit ou service particulier de distribution + : poste restante, boîte postale.' + code_postal_ville: + title: Code postal + type: string + description: Code postal et localité de destination. + example: '75002' + pays: + title: Pays + type: string + example: FRANCE + required: + - destinataire + - complement_information + - complement_information_geographique + - numero_libelle_voie + - lieu_dit + - code_postal_ville + - pays + quotient_familial: + title: Informations du quotient familial (QF) + type: object + description: Données relatives à l'attribution du quotient + familial CAF ou MSA. + properties: + fournisseur: + title: Fournisseur du QF + type: string + description: Indique si le quotient familial de l'allocataire + provient de la CAF ou de la MSA. + example: MSA + enum: + - CNAF + - MSA + valeur: + title: Valeur du QF + type: integer + description: Valeur du quotient familial calculé par la + CAF ou la MSA. + example: 1045 + annee: + title: Année effective du QF + type: integer + description: "Ce champ indique l'année effective du quotient + familial appelé. C'est-à-dire l'année à laquelle s'applique + le quotient familial. Cette année peut être différente + de l'année de calcul du quotient si ce dernier a été + recalculé suite à la réception d'informations rectifiant + la situation de l'allocataire. \n\n - Si aucune année + et aucun mois n'ont été renseignés en paramètres d'appel, + le quotient familial retourné sera celui du mois de + l'année en cours. - Si aucune année n'a été renseignée + et que le mois est renseigné, le quotient familial retourné + sera celui du mois spécifié pour l'année en cours. En + revanche, si la date finalement composée avec cette + règle s'avère dans le futur (mois postérieur au moins + en cours), l'API renvoie un erreur 400. " + example: 2023 + mois: + title: Mois effectif du QF + type: integer + description: "Mois effectif du quotient familial. C'est-à-dire + le mois auquel s'applique le quotient familial. Ce mois + peut être différent du mois de calcul du quotient si + ce dernier a été recalculé suite à la réception d'informations + rectifiant la situation de l'allocataire. \n\n - Si + aucun mois et aucune année n'ont été renseignés en paramètres + d'appel, le quotient familial retourné sera celui du + mois de l'année en cours. - Si le mois est renseigné + mais qu'aucune année n'est saisie, le quotient familial + retourné sera celui du mois spécifié pour l'année en + cours. En revanche, si la date finalement composée avec + cette règle s'avère dans le futur (mois postérieur au + moins en cours), l'API renvoie un erreur 400. - Si aucun + mois n'a été renseigné mais que l'année a été spécifiée + en paramètres d'appel, le quotient familial retourné + sera celui du mois en cours pour l'année spécifiée." + example: 6 + annee_calcul: + title: Année du calcul du QF + type: integer + description: "Année lors de laquelle le calcul du quotient + familial demandé a été effectué. Cette année peut différer + de l'année effective du quotient familial. \n\n Pour + la CAF, le quotient familial est recalculé uniquement + si de nouvelles informations sont venues rectifier la + situation de l'allocataire. \n Pour la MSA, le quotient + familial est systématiquement recalculé ; l'année correspond + donc toujours à l'année courante." + example: 2023 + mois_calcul: + title: Mois du calcul du QF + type: integer + description: "Mois lors duquel le calcul du quotient familial + demandé a été effectué. Ce mois peut différer du mois + effectif du quotient familial. \n\n Pour la CAF, le + quotient familial est recalculé uniquement si de nouvelles + informations sont venues rectifier la situation de l'allocataire. + \n Pour la MSA, le quotient familial est systématiquement + recalculé ; le mois correspond donc toujours au mois + en cours." + example: 9 + required: + - fournisseur + - valeur + - annee + - mois + - annee_calcul + - mois_calcul + required: + - allocataires + - enfants + - adresse + - quotient_familial + additionalProperties: false + links: + type: object + meta: + type: object + required: + - data + - links + - meta + '422': + description: Impossible d'identifier l'allocataire + content: + application/json: + examples: + entite_non_traitable_00366: + value: + errors: + - code: '00366' + title: Entité non traitable + detail: Un ou plusieurs paramètres de civilité ne sont pas correctement + formatés + source: + meta: {} + summary: Entité non traitable + description: Un ou plusieurs paramètres de civilité ne sont pas + correctement formatés + schema: + "$ref": "#/components/schemas/Error" + '404': + description: Dossier allocataire inexistant. Le document ne peut être édité. + content: + application/json: + examples: + dossier_allocataire_absent_msa_10003: + value: + errors: + - code: '10003' + title: Dossier allocataire absent MSA + detail: Le dossier allocataire n'a pas été trouvé auprès de + la MSA. + source: + meta: + provider: MSA + summary: Dossier allocataire absent MSA + description: Le dossier allocataire n'a pas été trouvé auprès de + la MSA. + dossier_allocataire_absent_cnaf_37003: + value: + errors: + - code: '37003' + title: Dossier allocataire absent CNAF + detail: Le dossier allocataire n'a pas été trouvé auprès de + la CNAF. + source: + meta: + provider: CNAV + summary: Dossier allocataire absent CNAF + description: Le dossier allocataire n'a pas été trouvé auprès de + la CNAF. + schema: + "$ref": "#/components/schemas/Error" + '502': + description: Erreur du fournisseur + content: + application/json: + examples: + provider_unknown_error: + value: + errors: + - code: '37999' + title: Erreur inconnue du fournisseur de données + detail: La réponse retournée par le fournisseur de données est + invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + source: + meta: + provider: CNAV + summary: Erreur inconnue du fournisseur de données + description: La réponse retournée par le fournisseur de données + est invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + schema: + "$ref": "#/components/schemas/Error" + '504': + description: Erreur d'intermédiaire + content: + application/json: + examples: + timeout_error: + value: + errors: + - code: '37002' + title: Intermédiaire hors-délai + detail: Temps d’attente d’une réponse du fournisseur de données + écoulé. + source: + meta: + provider: CNAV + summary: Intermédiaire hors-délai + description: Temps d’attente d’une réponse du fournisseur de données + écoulé. + provider_unavailable_error: + value: + errors: + - code: '37001' + title: Service non disponible + detail: Service du fournisseur de données temporairement indisponible + ou en maintenance. + source: + meta: + provider: CNAV + summary: Service non disponible + description: Service du fournisseur de données temporairement indisponible + ou en maintenance. + network_error: + value: + errors: + - code: '00501' + title: Erreur réseau + detail: Problème de connexion au serveur distant. L'erreur peut + venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + source: + meta: + retry_in: 10 + summary: Erreur réseau + description: Problème de connexion au serveur distant. L'erreur + peut venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + dns_resolution_error: + value: + errors: + - code: '37004' + title: Erreur de résolution DNS + detail: Problème de résolution DNS de l'adresse du serveur + source: + meta: + provider: CNAV + summary: Erreur de résolution DNS + description: Problème de résolution DNS de l'adresse du serveur + provider_error: + value: + errors: + - code: '37008' + title: 'Erreur auprès du fournisseur de données : trop de requêtes' + detail: 'Erreur de fournisseur de donnée : Trop de requêtes + effectuées, veuillez réessayer plus tard.' + source: + meta: + provider: CNAV + summary: 'Erreur auprès du fournisseur de données : trop de requêtes' + description: 'Erreur de fournisseur de donnée : Trop de requêtes + effectuées, veuillez réessayer plus tard.' + schema: + "$ref": "#/components/schemas/Error" + "/v3/dss/quotient_familial/france_connect": + get: + summary: Quotient familial CAF & MSA + tags: + - Quotient familial CAF & MSA + parameters: + - name: recipient + in: query + description: |- + "**Bénéficiaire de l’appel** + + SIRET de l’administration destinatrice des données." + example: '13002526500013' + required: true + schema: + type: string + security: + - jwt_bearer_token: [] + description: "Quotient familial délivré par la CAF ou la MSA et composition + de la famille de l'allocataire. \n Pour plus d'informations sur cette API + et obtenir un accès en avant-première, veuillez contacter l'équipe API Particulier. + \n **Données disponibles en bac à sable :** [liste](https://github.com/etalab/siade_staging_data/blob/develop/payloads/api_particulier_v2_cnav_quotient_familial_v2)" + responses: + '403': + description: Accès interdit + content: + application/json: + examples: + insufficient_privileges_error: + value: + errors: + - code: '00100' + title: Privilèges insuffisants + detail: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + source: + parameter: token + meta: {} + summary: Privilèges insuffisants + description: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + schema: + "$ref": "#/components/schemas/Error" + '200': + description: Dossier trouvé + headers: + X-Response-Cached: + schema: + type: boolean + example: true + enum: + - true + - false + default: false + description: Indique si la réponse a été caché. + X-Cache-Expires-in: + schema: + type: number + nullable: true + example: 9001 + description: Secondes avant que le cache n'expire. Si le cache est vide, + ce header est vide (mais présent). La durée du cache est de 24 heure. + x-operationId: api_particulier_v3_cnav_quotient_familial_with_france_connect + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + allocataires: + title: Données d'identité de l'allocataire et du conjoint + type: array + minItems: 1 + description: Liste des données d'identité de l'allocataire + appelé et de celles du conjoint le cas échéant. La provenance + de ces données n'est pas sourcée précisément et diffère + selon la CAF ou la MSA. + items: + type: object + properties: + nom_naissance: + title: Nom + type: string + description: Nom de naissance de l'allocataire ou du + conjoint. + example: JACQUES + nom_usage: + title: Nom d'usage + type: string + description: Nom d'usage de l'allocataire ou du conjoint. + example: DUPONT + nullable: true + prenoms: + title: Prénoms + type: string + description: Prénoms de l'allocataire ou du conjoint. + example: JEAN-PIERRE THOMAS + date_naissance: + title: Date de naissance + description: Date de naissance de l'allocataire ou du + conjoint au format AAAA-MM-JJ. + type: string + example: '2000-01-20' + sexe: + title: Sexe + type: string + description: Sexe de l'allocataire ou du conjoint. + example: M + enum: + - F + - M + enfants: + type: array + title: Données d'identité des enfants composant la famille + description: Liste des données d'identité des enfants composant + la famille, le cas échéant. La provenance de ces données + n'est pas sourcée précisément et diffère selon la CAF ou + la MSA. + items: + type: object + properties: + nom_naissance: + title: Nom de naissance + type: string + description: Nom de naissance de l'enfant. + example: DUPONT + nom_usage: + title: Nom d'usage + type: string + description: Nom d'usage de l'enfant. + example: + nullable: true + prenoms: + title: Prénoms + type: string + description: Prénoms de l'enfant. + example: JEAN-PIERRE THOMAS JUNIOR + date_naissance: + title: Date de naissance + description: Date de naissance de l'enfant au format + AAAA-MM-JJ. + type: string + example: '2000-01-20' + sexe: + title: Sexe + type: string + description: Sexe de l'enfant. + example: M + enum: + - F + - M + adresse: + title: Adresse de la famille + type: object + description: Adresse de la famille au format de la poste. + properties: + destinataire: + title: Identité du destinataire + type: string + example: Monsieur JEAN JACQUES + description: 'Identité du destinataire : Civilité, titre + ou qualité + nom et prénom' + complement_information: + title: Complément d'information du destinataire ou point + de remise + type: string + nullable: true + example: + complement_information_geographique: + title: Complément d'information du point géographique + type: string + nullable: true + example: + numero_libelle_voie: + title: Voie + type: string + description: Numéro et libellé de la voie. + example: 1 RUE DE LA GARE + nullable: true + lieu_dit: + title: Lieu-dit + type: string + nullable: true + example: + description: 'Lieu-dit ou service particulier de distribution + : poste restante, boîte postale.' + code_postal_ville: + title: Code postal + type: string + description: Code postal et localité de destination. + example: '75002' + pays: + title: Pays + type: string + example: FRANCE + required: + - destinataire + - complement_information + - complement_information_geographique + - numero_libelle_voie + - lieu_dit + - code_postal_ville + - pays + quotient_familial: + title: Informations du quotient familial (QF) + type: object + description: Données relatives à l'attribution du quotient + familial CAF ou MSA. + properties: + fournisseur: + title: Fournisseur du QF + type: string + description: Indique si le quotient familial de l'allocataire + provient de la CAF ou de la MSA. + example: MSA + enum: + - CNAF + - MSA + valeur: + title: Valeur du QF + type: integer + description: Valeur du quotient familial calculé par la + CAF ou la MSA. + example: 1045 + annee: + title: Année effective du QF + type: integer + description: "Ce champ indique l'année effective du quotient + familial appelé. C'est-à-dire l'année à laquelle s'applique + le quotient familial. Cette année peut être différente + de l'année de calcul du quotient si ce dernier a été + recalculé suite à la réception d'informations rectifiant + la situation de l'allocataire. \n\n - Si aucune année + et aucun mois n'ont été renseignés en paramètres d'appel, + le quotient familial retourné sera celui du mois de + l'année en cours. - Si aucune année n'a été renseignée + et que le mois est renseigné, le quotient familial retourné + sera celui du mois spécifié pour l'année en cours. En + revanche, si la date finalement composée avec cette + règle s'avère dans le futur (mois postérieur au moins + en cours), l'API renvoie un erreur 400. " + example: 2023 + mois: + title: Mois effectif du QF + type: integer + description: "Mois effectif du quotient familial. C'est-à-dire + le mois auquel s'applique le quotient familial. Ce mois + peut être différent du mois de calcul du quotient si + ce dernier a été recalculé suite à la réception d'informations + rectifiant la situation de l'allocataire. \n\n - Si + aucun mois et aucune année n'ont été renseignés en paramètres + d'appel, le quotient familial retourné sera celui du + mois de l'année en cours. - Si le mois est renseigné + mais qu'aucune année n'est saisie, le quotient familial + retourné sera celui du mois spécifié pour l'année en + cours. En revanche, si la date finalement composée avec + cette règle s'avère dans le futur (mois postérieur au + moins en cours), l'API renvoie un erreur 400. - Si aucun + mois n'a été renseigné mais que l'année a été spécifiée + en paramètres d'appel, le quotient familial retourné + sera celui du mois en cours pour l'année spécifiée." + example: 6 + annee_calcul: + title: Année du calcul du QF + type: integer + description: "Année lors de laquelle le calcul du quotient + familial demandé a été effectué. Cette année peut différer + de l'année effective du quotient familial. \n\n Pour + la CAF, le quotient familial est recalculé uniquement + si de nouvelles informations sont venues rectifier la + situation de l'allocataire. \n Pour la MSA, le quotient + familial est systématiquement recalculé ; l'année correspond + donc toujours à l'année courante." + example: 2023 + mois_calcul: + title: Mois du calcul du QF + type: integer + description: "Mois lors duquel le calcul du quotient familial + demandé a été effectué. Ce mois peut différer du mois + effectif du quotient familial. \n\n Pour la CAF, le + quotient familial est recalculé uniquement si de nouvelles + informations sont venues rectifier la situation de l'allocataire. + \n Pour la MSA, le quotient familial est systématiquement + recalculé ; le mois correspond donc toujours au mois + en cours." + example: 9 + required: + - fournisseur + - valeur + - annee + - mois + - annee_calcul + - mois_calcul + required: + - allocataires + - enfants + - adresse + - quotient_familial + additionalProperties: false + links: + type: object + meta: + type: object + required: + - data + - links + - meta + '422': + description: Impossible d'identifier l'allocataire + content: + application/json: + examples: + entite_non_traitable_00366: + value: + errors: + - code: '00366' + title: Entité non traitable + detail: Un ou plusieurs paramètres de civilité ne sont pas correctement + formatés + source: + meta: {} + summary: Entité non traitable + description: Un ou plusieurs paramètres de civilité ne sont pas + correctement formatés + schema: + "$ref": "#/components/schemas/Error" + '404': + description: Dossier allocataire inexistant. Le document ne peut être édité. + content: + application/json: + examples: + dossier_allocataire_absent_msa_10003: + value: + errors: + - code: '10003' + title: Dossier allocataire absent MSA + detail: Le dossier allocataire n'a pas été trouvé auprès de + la MSA. + source: + meta: + provider: MSA + summary: Dossier allocataire absent MSA + description: Le dossier allocataire n'a pas été trouvé auprès de + la MSA. + dossier_allocataire_absent_cnaf_37003: + value: + errors: + - code: '37003' + title: Dossier allocataire absent CNAF + detail: Le dossier allocataire n'a pas été trouvé auprès de + la CNAF. + source: + meta: + provider: CNAV + summary: Dossier allocataire absent CNAF + description: Le dossier allocataire n'a pas été trouvé auprès de + la CNAF. + schema: + "$ref": "#/components/schemas/Error" + "/v3/dss/revenu_solidarite_active/identite": + get: + summary: Statut revenu de solidarité active (RSA) + tags: + - Statut Revenu Solidarité Active (RSA) + parameters: + - name: recipient + in: query + description: |- + "**Bénéficiaire de l’appel** + + SIRET de l’administration destinatrice des données." + example: '13002526500013' + required: true + schema: + type: string + - name: Cache-Control + in: header + description: Si cette valeur est fixée à "no-cache", le système de cache est + alors ignoré et la donnée est directement récupérée depuis le fournisseur + de données. + schema: + type: string + - name: nomNaissance + in: query + description: "**Nom de naissance, également appelé nom de famille**. \n\nLe + nom de naissance est indiqué sur l'acte de naissance, de mariage, sur le + livret de famille, etc. Le nom de famille/naissance figure toujours sur + la pièce d'identité en premier, avant le nom d'usage si le particulier en + a un. \n\nEn cas de changement de nom de naissance, une mention avec le + nouveau nom de famille est inscrite sur l'acte de naissance. Pour appeler + l'API, le nom de naissance/famille nécessaire est bien le nom de famille + modifié." + example: DURANT + required: true + schema: + type: string + - name: nomUsage + in: query + description: "**Nom d'usage**. \n\nSi le particulier a un nom d'usage, c'est + le nom qu'il utilise généralement au quotidien. Le nom d'usage est facultatif + et peut changer au cours de la vie. Il correspond au nom de famille/naissance + d'un parent, d'un époux ou d'une épouse, seul ou accolé au nom de famille/naissance. + Par exemple, le nom d'usage ne peut pas être le nom de famille/naissance + d'un concubin ou d'un partenaire de pacs. \n\nSi le particulier en a fait + la demande, le nom d'usage peut être inscrit derrière le nom de naissance + sur la carte d'identité ou le passeport ; il peut également être celui utilisé + par l'administration sur les courriers. Le nom d'usage ne remplace pas le + nom de famille/naissance qui reste le seul mentionné. \nDans nos APIs, le + nom d'usage n'est jamais identique au nom de famille.\n\nPour en savoir + plus : https://www.service-public.fr/particuliers/vosdroits/F868." + example: DUPONT DURANT + required: false + schema: + type: string + - name: prenoms[] + in: query + schema: + type: array + minItems: 1 + maxItems: 3 + items: + type: string + example: + - PIERRE + - RICHARD + description: "**Liste des prénoms**. \n\nFournir plusieurs prénoms maximise + les chances que l'API retrouve le particulier car cela permet de limiter + le risque d’homonymie." + required: true + - name: anneeDateNaissance + in: query + description: "**Année de naissance**. \n\nPour un particulier né en France, + dans le cadre d'un appel à l'API avec l'utilisation du paramètre 'nomCommuneNaissance', + ce paramètre est obligatoire (ainsi que le paramètre 'codeCogInseeDepartementNaissance') + afin de retrouver le code COG de la commune de naissance." + example: 1990 + required: false + schema: + type: integer + - name: moisDateNaissance + in: query + description: "**Mois de naissance**. \n\nCette valeur est ignorée si le paramètre + 'anneeDateNaissance' est vide." + example: 1 + required: false + schema: + type: integer + - name: jourDateNaissance + in: query + description: "**Jour de naissance**. \n\nCette valeur est ignorée si le paramètre + 'moisDateNaissance' ou le paramètre 'anneeDateNaissance' est vide.\"" + example: 1 + required: false + schema: + type: integer + - name: sexeEtatCivil + in: query + schema: + type: string + enum: + - M + - F + description: "**Sexe de la personne tel qu'indiqué sur les actes d'état civil**, + comme par exemple l'acte de naissance ou de mariage. \n\nDans la majorité + des cas, il s'agit également de la mention indiquée sur la pièce d'identité + et le passeport. Cette mention peut être masculin ('M') ou féminin ('F'). + \nDans le cas d'un particulier ayant demandé une modification de sa mention + de sexe à l'état civil, le changement est indiqué en marge de l'acte de + naissance une fois la décision rendue. Le changement intervient sur les + titres d'identité seulement si le particulier en demande le renouvellement." + example: M + required: true + - name: codeCogInseePaysNaissance + in: query + schema: + type: string + minLength: 5 + maxLength: 5 + example: '99100' + description: |- + **Code Insee à 5 chiffres du pays de naissance**. + + - Code Insee France = 99100 ; + - Liste de tous les codes Insee des pays étrangers depuis 1943 : https://explore.data.gouv.fr/fr/datasets/58c984b088ee386cdb1261f3/#/resources/150889d3-ffda-4ea5-8709-6ee67415294f. + required: true + - name: codeCogInseeCommuneNaissance + in: query + schema: + type: string + minLength: 5 + maxLength: 5 + example: '08480' + description: "**Code Insee à 5 chiffres de la commune de naissance**. \n\nPour + retrouver un particulier né en France, il est nécessaire d'indiquer sa commune + de naissance. Ce paramètre est une des deux options disponibles pour renseigner + la commune de naissance. En l'absence de l'utilisation de la seconde option + (triplet 'nomCommuneNaissance', 'anneeDateNaissance', 'codeInseeDepartementNaissance'), + ce paramètre est obligatoire si la personne est née en France.\n\nNe pas + remplir si la personne est née à l'étranger." + required: false + - name: nomCommuneNaissance + in: query + schema: + type: string + minLength: 1 + example: Gennevilliers + description: "**Nom en toute lettre de la commune de naissance**. \n\nPour + retrouver un particulier né en France, il est nécessaire d'indiquer sa commune + de naissance. Ce paramètre est une des deux options disponibles pour renseigner + la commune de naissance. En l'absence de l'utilisation du 'codeCogInseeCommuneNaissance', + ce paramètre est obligatoire si la personne est née en France ; il doit + être obligatoirement accompagné des paramètres 'codeCogInseeDepartementNaissance' + et 'anneeDateNaissance'.\n\nNe pas remplir si la personne est née à l'étranger." + required: false + - name: codeCogInseeDepartementNaissance + in: query + schema: + type: string + minLength: 2 + maxLength: 3 + example: '92' + description: "**Code INSEE du département de naissance**. \n\nPour retrouver + un particulier né en France, il est nécessaire d'indiquer sa commune de + naissance. Ce paramètre fait partie d'une des deux options disponibles pour + renseigner la commune de naissance. Lorsque le paramètre 'nomCommuneNaissance' + est utilisé, ce paramètre est obligatoire si la personne est née en France + et permet de retrouver le code COG avec le paramètre 'anneeDateNaissance'.\n\nNe + pas remplir si la personne est née à l'étranger." + required: false + security: + - jwt_bearer_token: [] + description: "Statut bénéficiaire du revenu de solidarité active (RSA), majoré + ou non. \n\n Retourne également des informations sur les dates d'ouverture + des droits." + responses: + '401': + description: Non autorisé + content: + application/json: + examples: + invalid_token_error: + value: + errors: + - code: '00101' + title: Interdit + detail: Votre token n'est pas valide ou n'est pas renseigné + source: + parameter: token + meta: {} + summary: Interdit + description: Votre token n'est pas valide ou n'est pas renseigné + expired_token_error: + value: + errors: + - code: '00103' + title: Jeton expiré + detail: Votre token est expiré. Vous devez refaire une demande + source: + parameter: token + meta: {} + summary: Jeton expiré + description: Votre token est expiré. Vous devez refaire une demande + blacklisted_token_error: + value: + errors: + - code: '00105' + title: Jeton sur liste noire + detail: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver + un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + source: + parameter: token + meta: {} + summary: Jeton sur liste noire + description: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver un + jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + schema: + "$ref": "#/components/schemas/Error" + '403': + description: Accès interdit + content: + application/json: + examples: + insufficient_privileges_error: + value: + errors: + - code: '00100' + title: Privilèges insuffisants + detail: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + source: + parameter: token + meta: {} + summary: Privilèges insuffisants + description: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + schema: + "$ref": "#/components/schemas/Error" + '429': + description: Trop de requêtes + content: + application/json: + examples: + too_many_requests_error: + value: + errors: + - code: '00429' + title: Trop de requêtes + detail: Vous avez effectué trop de requêtes + source: + meta: {} + summary: Trop de requêtes + description: Vous avez effectué trop de requêtes + schema: + "$ref": "#/components/schemas/Error" + '200': + description: Revenu solidarité active trouvée + headers: + X-Response-Cached: + schema: + type: boolean + example: true + enum: + - true + - false + default: false + description: Indique si la réponse a été caché. + X-Cache-Expires-in: + schema: + type: number + nullable: true + example: 9001 + description: Secondes avant que le cache n'expire. Si le cache est vide, + ce header est vide (mais présent). La durée du cache est de 1 heure. + x-operationId: api_particulier_v3_cnav_revenu_solidarite_active_with_civility + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + est_beneficiaire: + title: Statut bénéficiaire du revenu de solidarité active + (RSA) + type: boolean + example: true + description: Indique que le particulier est bénéficiaire du + revenu de solidarité active au moment de l'appel. + avec_majoration: + title: RSA majoré + type: boolean + nullable: true + description: "Indique que le RSA du particulier bénéficiaire + est majoré au moment de l'appel. \n Si ce champ est à false, + cela signifie que le RSA n'est pas majoré. \n Ce champ est + null dans le cas où le particulier n'est pas bénéficiaire + du RSA." + example: false + date_debut_droit: + title: Date d'ouverture du droit au RSA + type: string + nullable: true + description: "Date de début de droit au RSA du particulier + bénéficiaire. \n Ce champ est null dans le cas où le particulier + n'est pas bénéficiaire du RSA." + example: '1992-11-29' + required: + - est_beneficiaire + - avec_majoration + - date_debut_droit + additionalProperties: false + links: + type: object + meta: + type: object + required: + - data + - links + - meta + '404': + description: Dossier non trouvé + content: + application/json: + examples: + entite_non_trouvee_37003: + value: + errors: + - code: '37003' + title: Entité non trouvée + detail: Dossier allocataire inexistant. Le document ne peut + être édité. + source: + meta: + provider: CNAV + summary: Entité non trouvée + description: Dossier allocataire inexistant. Le document ne peut + être édité. + schema: + "$ref": "#/components/schemas/Error" + '502': + description: Erreur du fournisseur + content: + application/json: + examples: + provider_unknown_error: + value: + errors: + - code: '37999' + title: Erreur inconnue du fournisseur de données + detail: La réponse retournée par le fournisseur de données est + invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + source: + meta: + provider: CNAV + summary: Erreur inconnue du fournisseur de données + description: La réponse retournée par le fournisseur de données + est invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + schema: + "$ref": "#/components/schemas/Error" + '504': + description: Erreur d'intermédiaire + content: + application/json: + examples: + timeout_error: + value: + errors: + - code: '37002' + title: Intermédiaire hors-délai + detail: Temps d’attente d’une réponse du fournisseur de données + écoulé. + source: + meta: + provider: CNAV + summary: Intermédiaire hors-délai + description: Temps d’attente d’une réponse du fournisseur de données + écoulé. + provider_unavailable_error: + value: + errors: + - code: '37001' + title: Service non disponible + detail: Service du fournisseur de données temporairement indisponible + ou en maintenance. + source: + meta: + provider: CNAV + summary: Service non disponible + description: Service du fournisseur de données temporairement indisponible + ou en maintenance. + network_error: + value: + errors: + - code: '00501' + title: Erreur réseau + detail: Problème de connexion au serveur distant. L'erreur peut + venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + source: + meta: + retry_in: 10 + summary: Erreur réseau + description: Problème de connexion au serveur distant. L'erreur + peut venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + dns_resolution_error: + value: + errors: + - code: '37004' + title: Erreur de résolution DNS + detail: Problème de résolution DNS de l'adresse du serveur + source: + meta: + provider: CNAV + summary: Erreur de résolution DNS + description: Problème de résolution DNS de l'adresse du serveur + provider_error: + value: + errors: + - code: '37008' + title: 'Erreur auprès du fournisseur de données : trop de requêtes' + detail: 'Erreur de fournisseur de donnée : Trop de requêtes + effectuées, veuillez réessayer plus tard.' + source: + meta: + provider: CNAV + summary: 'Erreur auprès du fournisseur de données : trop de requêtes' + description: 'Erreur de fournisseur de donnée : Trop de requêtes + effectuées, veuillez réessayer plus tard.' + schema: + "$ref": "#/components/schemas/Error" + "/v3/dss/revenu_solidarite_active/france_connect": + get: + summary: Statut revenu de solidarité active (RSA) + tags: + - Statut Revenu Solidarité Active (RSA) + parameters: + - name: recipient + in: query + description: |- + "**Bénéficiaire de l’appel** + + SIRET de l’administration destinatrice des données." + example: '13002526500013' + required: true + schema: + type: string + security: + - jwt_bearer_token: [] + description: "Statut bénéficiaire du revenu de solidarité active (RSA), majoré + ou non. \n\n Retourne également des informations sur les dates d'ouverture + des droits." + responses: + '403': + description: Accès interdit + content: + application/json: + examples: + insufficient_privileges_error: + value: + errors: + - code: '00100' + title: Privilèges insuffisants + detail: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + source: + parameter: token + meta: {} + summary: Privilèges insuffisants + description: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + schema: + "$ref": "#/components/schemas/Error" + '200': + description: Dossier trouvé + headers: + X-Response-Cached: + schema: + type: boolean + example: true + enum: + - true + - false + default: false + description: Indique si la réponse a été caché. + X-Cache-Expires-in: + schema: + type: number + nullable: true + example: 9001 + description: Secondes avant que le cache n'expire. Si le cache est vide, + ce header est vide (mais présent). La durée du cache est de 1 heure. + x-operationId: api_particulier_v3_cnav_revenu_solidarite_active_with_france_connect + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + est_beneficiaire: + title: Statut bénéficiaire du revenu de solidarité active + (RSA) + type: boolean + example: true + description: Indique que le particulier est bénéficiaire du + revenu de solidarité active au moment de l'appel. + avec_majoration: + title: RSA majoré + type: boolean + nullable: true + description: "Indique que le RSA du particulier bénéficiaire + est majoré au moment de l'appel. \n Si ce champ est à false, + cela signifie que le RSA n'est pas majoré. \n Ce champ est + null dans le cas où le particulier n'est pas bénéficiaire + du RSA." + example: false + date_debut_droit: + title: Date d'ouverture du droit au RSA + type: string + nullable: true + description: "Date de début de droit au RSA du particulier + bénéficiaire. \n Ce champ est null dans le cas où le particulier + n'est pas bénéficiaire du RSA." + example: '1992-11-29' + required: + - est_beneficiaire + - avec_majoration + - date_debut_droit + additionalProperties: false + links: + type: object + meta: + type: object + required: + - data + - links + - meta + '404': + description: Dossier non trouvé + content: + application/json: + examples: + entite_non_trouvee_37003: + value: + errors: + - code: '37003' + title: Entité non trouvée + detail: Dossier allocataire inexistant. Le document ne peut + être édité. + source: + meta: + provider: CNAV + summary: Entité non trouvée + description: Dossier allocataire inexistant. Le document ne peut + être édité. + schema: + "$ref": "#/components/schemas/Error" + "/v3/cnous/etudiant_boursier/identite": + get: + summary: Status étudiant boursier + tags: + - Statut étudiant boursier + parameters: + - name: recipient + in: query + description: |- + "**Bénéficiaire de l’appel** + + SIRET de l’administration destinatrice des données." + example: '13002526500013' + required: true + schema: + type: string + - name: nomNaissance + in: query + description: "**Nom de naissance, également appelé nom de famille**. \n\nLe + nom de naissance est indiqué sur l'acte de naissance, de mariage, sur le + livret de famille, etc. Le nom de famille/naissance figure toujours sur + la pièce d'identité en premier, avant le nom d'usage si le particulier en + a un. \n\nEn cas de changement de nom de naissance, une mention avec le + nouveau nom de famille est inscrite sur l'acte de naissance. Pour appeler + l'API, le nom de naissance/famille nécessaire est bien le nom de famille + modifié." + example: DURANT + required: true + schema: + type: string + - name: prenoms[] + in: query + schema: + type: array + minItems: 1 + maxItems: 3 + items: + type: string + example: + - PIERRE + - RICHARD + description: "**Liste des prénoms**. \n\nFournir plusieurs prénoms maximise + les chances que l'API retrouve le particulier car cela permet de limiter + le risque d’homonymie." + required: true + - name: anneeDateNaissance + in: query + description: "**Année de naissance**. \n\nPour un particulier né en France, + dans le cadre d'un appel à l'API avec l'utilisation du paramètre 'nomCommuneNaissance', + ce paramètre est obligatoire (ainsi que le paramètre 'codeCogInseeDepartementNaissance') + afin de retrouver le code COG de la commune de naissance." + example: 1990 + required: true + schema: + type: integer + - name: moisDateNaissance + in: query + description: "**Mois de naissance**." + example: 1 + required: true + schema: + type: integer + - name: jourDateNaissance + in: query + description: "**Jour de naissance**." + example: 1 + required: true + schema: + type: integer + - name: sexeEtatCivil + in: query + schema: + type: string + enum: + - M + - F + description: "**Sexe de la personne tel qu'indiqué sur les actes d'état civil**, + comme par exemple l'acte de naissance ou de mariage. \n\nDans la majorité + des cas, il s'agit également de la mention indiquée sur la pièce d'identité + et le passeport. Cette mention peut être masculin ('M') ou féminin ('F'). + \nDans le cas d'un particulier ayant demandé une modification de sa mention + de sexe à l'état civil, le changement est indiqué en marge de l'acte de + naissance une fois la décision rendue. Le changement intervient sur les + titres d'identité seulement si le particulier en demande le renouvellement." + example: M + required: false + - name: codeCogInseeCommuneNaissance + in: query + schema: + type: string + minLength: 5 + maxLength: 5 + example: '08480' + description: "**Code Insee à 5 chiffres de la commune de naissance**. \n\nPour + retrouver un particulier né en France, il est nécessaire d'indiquer sa commune + de naissance. Ce paramètre est une des deux options disponibles pour renseigner + la commune de naissance. En l'absence de l'utilisation de la seconde option + (triplet 'nomCommuneNaissance', 'anneeDateNaissance', 'codeInseeDepartementNaissance').\n\nNe + pas remplir si la personne est née à l'étranger." + required: false + - name: nomCommuneNaissance + in: query + schema: + type: string + minLength: 1 + example: Gennevilliers + description: "**Nom en toute lettre de la commune de naissance**. \n\nPour + retrouver un particulier né en France, il est nécessaire d'indiquer sa commune + de naissance. Ce paramètre est une des deux options disponibles pour renseigner + la commune de naissance. En l'absence de l'utilisation du 'codeCogInseeCommuneNaissance', + ce paramètre est obligatoire si la personne est née en France ; il doit + être obligatoirement accompagné des paramètres 'codeCogInseeDepartementNaissance' + et 'anneeDateNaissance'.\n\nNe pas remplir si la personne est née à l'étranger." + required: false + - name: codeCogInseeDepartementNaissance + in: query + schema: + type: string + minLength: 2 + maxLength: 3 + example: '92' + description: "**Code INSEE du département de naissance**. \n\nPour retrouver + un particulier né en France, il est nécessaire d'indiquer sa commune de + naissance. Ce paramètre fait partie d'une des deux options disponibles pour + renseigner la commune de naissance. Lorsque le paramètre 'nomCommuneNaissance' + est utilisé, ce paramètre est obligatoire si la personne est née en France + et permet de retrouver le code COG avec le paramètre 'anneeDateNaissance'.\n\nNe + pas remplir si la personne est née à l'étranger." + required: false + security: + - jwt_bearer_token: [] + description: Statut et échelon boursier d'un étudiant, délivrés par le Cnous. + responses: + '401': + description: Non autorisé + content: + application/json: + examples: + invalid_token_error: + value: + errors: + - code: '00101' + title: Interdit + detail: Votre token n'est pas valide ou n'est pas renseigné + source: + parameter: token + meta: {} + summary: Interdit + description: Votre token n'est pas valide ou n'est pas renseigné + expired_token_error: + value: + errors: + - code: '00103' + title: Jeton expiré + detail: Votre token est expiré. Vous devez refaire une demande + source: + parameter: token + meta: {} + summary: Jeton expiré + description: Votre token est expiré. Vous devez refaire une demande + blacklisted_token_error: + value: + errors: + - code: '00105' + title: Jeton sur liste noire + detail: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver + un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + source: + parameter: token + meta: {} + summary: Jeton sur liste noire + description: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver un + jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + schema: + "$ref": "#/components/schemas/Error" + '403': + description: Accès interdit + content: + application/json: + examples: + insufficient_privileges_error: + value: + errors: + - code: '00100' + title: Privilèges insuffisants + detail: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + source: + parameter: token + meta: {} + summary: Privilèges insuffisants + description: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + schema: + "$ref": "#/components/schemas/Error" + '429': + description: Trop de requêtes + content: + application/json: + examples: + too_many_requests_error: + value: + errors: + - code: '00429' + title: Trop de requêtes + detail: Vous avez effectué trop de requêtes + source: + meta: {} + summary: Trop de requêtes + description: Vous avez effectué trop de requêtes + schema: + "$ref": "#/components/schemas/Error" + '200': + description: Étudiant identifié + x-operationId: api_particulier_v3_cnous_etudiant_boursier_with_civility + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + est_boursier: + title: Statut boursier + type: boolean + description: Indique si l'étudiant est boursier + example: true + periode_versement_bourse: + title: Période de versement de la bourse + description: Informations relatives à la période de versement + de la bourse de l'étudiant. + type: object + properties: + date_rentree: + title: Date de rentrée + type: string + format: date + description: Date de rentrée scolaire ou universitaire + de l'étudiant, correspondant au début de la période + de versement de la bourse. + example: '2019-09-01' + duree: + title: Durée de versement + type: number + description: Nombre de mois de versement de la bourse + à l'étudiant. + example: 12 + required: + - date_rentree + - duree + etablissement_etudes: + title: Établissement d'études de l'étudiant + description: Contient le détail des informations concernant + l'établissement dans lequel l'étudiant fait ses études + type: object + properties: + nom_commune: + title: Ville d'études + type: string + description: Libellé de la ville d'études de l'étudiant + example: Brest + nom_etablissement: + title: Établissement d'études + type: string + description: L'établissement d'études de l'étudiant + example: Carnot + required: + - nom_commune + - nom_etablissement + echelon_bourse: + title: Échelon de la bourse + description: Informations relatives à l'échelon de la bourse + type: object + properties: + echelon: + title: Échelon de la bourse + type: string + description: "Ce champ indique l'échelon de la bourse + de l'étudiant. Il existe 8 échelons de bourse, de 0bis + à 7, correspondant aux montants reçus par l'étudiant + pour l'année scolaire. \n\n Pour en savoir plus, consulter + la FAQ : https://particulier.api.gouv.fr/catalogue/cnous/statut_etudiant_boursier#faq_entry_answer_0_api_particulier_endpoint_cnous_statut_etudiant_boursier." + example: '6' + enum: + - 0bis + - '1' + - '2' + - '3' + - '4' + - '5' + - '6' + - '7' + echelon_bourse_regionale_provisoire: + title: Statut provisoire de l'échelon (bourses régionales + uniquement) + description: Ce champs indique que l'échelon de la bourse + est provisoire. Ce statut provisoire de l'échelon n'est + effectif que pour les boursiers bénéficiaires d'une + bourse régionale. + type: boolean + example: true + enum: + - true + - false + required: + - echelon + - echelon_bourse_regionale_provisoire + email: + title: E-mail + type: string + description: Adresse e-mail de l'étudiant boursier. + example: georges@moustaki.fr + identite: + title: Données d'identité + type: object + description: "Données d'identité de l'étudiant boursier. Ces + informations d'identité sont saisies manuellement par les + étudiants. \n\n - Dans le cas des étudiants avec bourse + nationale, les informations sont vérifiées par un agent + via la pièce d'identité fournie (sauf le lieu de naissance) + ; \n\n - Dans le cas des étudiants avec bourse régionale, + les informations ne sont pas revérfiées avant d'être remontées + au Cnous, mais si l'étudiant est déjà connu du Cnous, c'est + l'identité vérifiée du Cnous qui sera retenue." + properties: + nom: + title: Nom de naissance + type: string + description: Nom de naissance de l'étudiant boursier. + example: Moustaki + prenoms: + type: array + minItems: 1 + items: + type: string + example: + - PIERRE + - RICHARD + date_naissance: + title: Date de naissance + type: string + format: date + description: Date de naissance de l'étudiant boursier. + example: '1992-11-29' + nom_commune_naissance: + title: Commune de naissance + type: string + description: Libellé de la commune de naissance de l'étudiant + boursier. + example: Poitiers + sexe: + title: Sexe + type: string + description: Sexe de l'étudiant boursier. + example: M + enum: + - M + - F + required: + - nom + - prenoms + - date_naissance + - nom_commune_naissance + - sexe + required: + - est_boursier + - periode_versement_bourse + - etablissement_etudes + - echelon_bourse + - email + - identite + additionalProperties: false + links: + type: object + meta: + type: object + required: + - data + - links + - meta + '404': + description: Étudiant non identifié + content: + application/json: + examples: + entite_non_trouvee_26003: + value: + errors: + - code: '26003' + title: Entité non trouvée + detail: Aucun étudiant boursier n'a pu être trouvé avec les + critères de recherche fournis. + source: + meta: + provider: CNOUS + summary: Entité non trouvée + description: Aucun étudiant boursier n'a pu être trouvé avec les + critères de recherche fournis. + schema: + "$ref": "#/components/schemas/Error" + '502': + description: Erreur du fournisseur + content: + application/json: + examples: + provider_unknown_error: + value: + errors: + - code: '26999' + title: Erreur inconnue du fournisseur de données + detail: La réponse retournée par le fournisseur de données est + invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + source: + meta: + provider: CNOUS + summary: Erreur inconnue du fournisseur de données + description: La réponse retournée par le fournisseur de données + est invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + schema: + "$ref": "#/components/schemas/Error" + '504': + description: Erreur d'intermédiaire + content: + application/json: + examples: + timeout_error: + value: + errors: + - code: '26002' + title: Intermédiaire hors-délai + detail: Temps d’attente d’une réponse du fournisseur de données + écoulé. + source: + meta: + provider: CNOUS + summary: Intermédiaire hors-délai + description: Temps d’attente d’une réponse du fournisseur de données + écoulé. + provider_unavailable_error: + value: + errors: + - code: '26001' + title: Service non disponible + detail: Service du fournisseur de données temporairement indisponible + ou en maintenance. + source: + meta: + provider: CNOUS + summary: Service non disponible + description: Service du fournisseur de données temporairement indisponible + ou en maintenance. + network_error: + value: + errors: + - code: '00501' + title: Erreur réseau + detail: Problème de connexion au serveur distant. L'erreur peut + venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + source: + meta: + retry_in: 10 + summary: Erreur réseau + description: Problème de connexion au serveur distant. L'erreur + peut venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + dns_resolution_error: + value: + errors: + - code: '26004' + title: Erreur de résolution DNS + detail: Problème de résolution DNS de l'adresse du serveur + source: + meta: + provider: CNOUS + summary: Erreur de résolution DNS + description: Problème de résolution DNS de l'adresse du serveur + schema: + "$ref": "#/components/schemas/Error" + "/v3/cnous/etudiant_boursier/france_connect": + get: + summary: Status étudiant boursier + tags: + - Statut étudiant boursier + parameters: + - name: recipient + in: query + description: |- + "**Bénéficiaire de l’appel** + + SIRET de l’administration destinatrice des données." + example: '13002526500013' + required: true + schema: + type: string + security: + - jwt_bearer_token: [] + description: Statut et échelon boursier d'un étudiant, délivrés par le Cnous. + responses: + '403': + description: Accès interdit + content: + application/json: + examples: + insufficient_privileges_error: + value: + errors: + - code: '00100' + title: Privilèges insuffisants + detail: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + source: + parameter: token + meta: {} + summary: Privilèges insuffisants + description: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + schema: + "$ref": "#/components/schemas/Error" + '200': + description: Étudiant identifié + x-operationId: api_particulier_v3_cnous_etudiant_boursier_with_france_connect + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + est_boursier: + title: Statut boursier + type: boolean + description: Indique si l'étudiant est boursier + example: true + periode_versement_bourse: + title: Période de versement de la bourse + description: Informations relatives à la période de versement + de la bourse de l'étudiant. + type: object + properties: + date_rentree: + title: Date de rentrée + type: string + format: date + description: Date de rentrée scolaire ou universitaire + de l'étudiant, correspondant au début de la période + de versement de la bourse. + example: '2019-09-01' + duree: + title: Durée de versement + type: number + description: Nombre de mois de versement de la bourse + à l'étudiant. + example: 12 + required: + - date_rentree + - duree + etablissement_etudes: + title: Établissement d'études de l'étudiant + description: Contient le détail des informations concernant + l'établissement dans lequel l'étudiant fait ses études + type: object + properties: + nom_commune: + title: Ville d'études + type: string + description: Libellé de la ville d'études de l'étudiant + example: Brest + nom_etablissement: + title: Établissement d'études + type: string + description: L'établissement d'études de l'étudiant + example: Carnot + required: + - nom_commune + - nom_etablissement + echelon_bourse: + title: Échelon de la bourse + description: Informations relatives à l'échelon de la bourse + type: object + properties: + echelon: + title: Échelon de la bourse + type: string + description: "Ce champ indique l'échelon de la bourse + de l'étudiant. Il existe 8 échelons de bourse, de 0bis + à 7, correspondant aux montants reçus par l'étudiant + pour l'année scolaire. \n\n Pour en savoir plus, consulter + la FAQ : https://particulier.api.gouv.fr/catalogue/cnous/statut_etudiant_boursier#faq_entry_answer_0_api_particulier_endpoint_cnous_statut_etudiant_boursier." + example: '6' + enum: + - 0bis + - '1' + - '2' + - '3' + - '4' + - '5' + - '6' + - '7' + echelon_bourse_regionale_provisoire: + title: Statut provisoire de l'échelon (bourses régionales + uniquement) + description: Ce champs indique que l'échelon de la bourse + est provisoire. Ce statut provisoire de l'échelon n'est + effectif que pour les boursiers bénéficiaires d'une + bourse régionale. + type: boolean + example: true + enum: + - true + - false + required: + - echelon + - echelon_bourse_regionale_provisoire + email: + title: E-mail + type: string + description: Adresse e-mail de l'étudiant boursier. + example: georges@moustaki.fr + required: + - est_boursier + - periode_versement_bourse + - etablissement_etudes + - echelon_bourse + - email + additionalProperties: false + links: + type: object + meta: + type: object + required: + - data + - links + - meta + '404': + description: Étudiant non identifié + content: + application/json: + examples: + entite_non_trouvee_26003: + value: + errors: + - code: '26003' + title: Entité non trouvée + detail: Aucun étudiant boursier n'a pu être trouvé. + source: + meta: + provider: CNOUS + summary: Entité non trouvée + description: Aucun étudiant boursier n'a pu être trouvé. + schema: + "$ref": "#/components/schemas/Error" + "/v3/cnous/etudiant_boursier/ine": + get: + summary: Status étudiant boursier + tags: + - Statut étudiant boursier + parameters: + - name: recipient + in: query + description: |- + "**Bénéficiaire de l’appel** + + SIRET de l’administration destinatrice des données." + example: '13002526500013' + required: true + schema: + type: string + - name: ine + in: query + description: Identifiant National Étudiant (INE). Cet identifiant est unique + à chaque étudiant sur le territoire français. Il est composé de 11 caractères, + 10 chiffres et 1 lettre, et depuis la rentrée 2018, 9 chiffres et 2 lettres. + Les étudiants peuvent retrouver leur numéro INE sur leur carte étudiant + et leur certificat de scolarité. + example: 1234567890G + schema: + type: string + pattern: "^[0-9a-zA-Z]{11}$" + required: true + security: + - jwt_bearer_token: [] + description: Statut et échelon boursier d'un étudiant, délivrés par le Cnous. + responses: + '401': + description: Non autorisé + content: + application/json: + examples: + invalid_token_error: + value: + errors: + - code: '00101' + title: Interdit + detail: Votre token n'est pas valide ou n'est pas renseigné + source: + parameter: token + meta: {} + summary: Interdit + description: Votre token n'est pas valide ou n'est pas renseigné + expired_token_error: + value: + errors: + - code: '00103' + title: Jeton expiré + detail: Votre token est expiré. Vous devez refaire une demande + source: + parameter: token + meta: {} + summary: Jeton expiré + description: Votre token est expiré. Vous devez refaire une demande + blacklisted_token_error: + value: + errors: + - code: '00105' + title: Jeton sur liste noire + detail: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver + un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + source: + parameter: token + meta: {} + summary: Jeton sur liste noire + description: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver un + jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + schema: + "$ref": "#/components/schemas/Error" + '403': + description: Accès interdit + content: + application/json: + examples: + insufficient_privileges_error: + value: + errors: + - code: '00100' + title: Privilèges insuffisants + detail: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + source: + parameter: token + meta: {} + summary: Privilèges insuffisants + description: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + schema: + "$ref": "#/components/schemas/Error" + '429': + description: Trop de requêtes + content: + application/json: + examples: + too_many_requests_error: + value: + errors: + - code: '00429' + title: Trop de requêtes + detail: Vous avez effectué trop de requêtes + source: + meta: {} + summary: Trop de requêtes + description: Vous avez effectué trop de requêtes + schema: + "$ref": "#/components/schemas/Error" + '200': + description: Étudiant identifié + x-operationId: api_particulier_v3_cnous_etudiant_boursier_with_ine + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + est_boursier: + title: Statut boursier + type: boolean + description: Indique si l'étudiant est boursier + example: true + periode_versement_bourse: + title: Période de versement de la bourse + description: Informations relatives à la période de versement + de la bourse de l'étudiant. + type: object + properties: + date_rentree: + title: Date de rentrée + type: string + format: date + description: Date de rentrée scolaire ou universitaire + de l'étudiant, correspondant au début de la période + de versement de la bourse. + example: '2019-09-01' + duree: + title: Durée de versement + type: number + description: Nombre de mois de versement de la bourse + à l'étudiant. + example: 12 + required: + - date_rentree + - duree + etablissement_etudes: + title: Établissement d'études de l'étudiant + description: Contient le détail des informations concernant + l'établissement dans lequel l'étudiant fait ses études + type: object + properties: + nom_commune: + title: Ville d'études + type: string + description: Libellé de la ville d'études de l'étudiant + example: Brest + nom_etablissement: + title: Établissement d'études + type: string + description: L'établissement d'études de l'étudiant + example: Carnot + required: + - nom_commune + - nom_etablissement + echelon_bourse: + title: Échelon de la bourse + description: Informations relatives à l'échelon de la bourse + type: object + properties: + echelon: + title: Échelon de la bourse + type: string + description: "Ce champ indique l'échelon de la bourse + de l'étudiant. Il existe 8 échelons de bourse, de 0bis + à 7, correspondant aux montants reçus par l'étudiant + pour l'année scolaire. \n\n Pour en savoir plus, consulter + la FAQ : https://particulier.api.gouv.fr/catalogue/cnous/statut_etudiant_boursier#faq_entry_answer_0_api_particulier_endpoint_cnous_statut_etudiant_boursier." + example: '6' + enum: + - 0bis + - '1' + - '2' + - '3' + - '4' + - '5' + - '6' + - '7' + echelon_bourse_regionale_provisoire: + title: Statut provisoire de l'échelon (bourses régionales + uniquement) + description: Ce champs indique que l'échelon de la bourse + est provisoire. Ce statut provisoire de l'échelon n'est + effectif que pour les boursiers bénéficiaires d'une + bourse régionale. + type: boolean + example: true + enum: + - true + - false + required: + - echelon + - echelon_bourse_regionale_provisoire + email: + title: E-mail + type: string + description: Adresse e-mail de l'étudiant boursier. + example: georges@moustaki.fr + identite: + title: Données d'identité + type: object + description: "Données d'identité de l'étudiant boursier. Ces + informations d'identité sont saisies manuellement par les + étudiants. \n\n - Dans le cas des étudiants avec bourse + nationale, les informations sont vérifiées par un agent + via la pièce d'identité fournie (sauf le lieu de naissance) + ; \n\n - Dans le cas des étudiants avec bourse régionale, + les informations ne sont pas revérfiées avant d'être remontées + au Cnous, mais si l'étudiant est déjà connu du Cnous, c'est + l'identité vérifiée du Cnous qui sera retenue." + properties: + nom: + title: Nom de naissance + type: string + description: Nom de naissance de l'étudiant boursier. + example: Moustaki + prenoms: + type: array + minItems: 1 + items: + type: string + example: + - PIERRE + - RICHARD + date_naissance: + title: Date de naissance + type: string + format: date + description: Date de naissance de l'étudiant boursier. + example: '1992-11-29' + nom_commune_naissance: + title: Commune de naissance + type: string + description: Libellé de la commune de naissance de l'étudiant + boursier. + example: Poitiers + sexe: + title: Sexe + type: string + description: Sexe de l'étudiant boursier. + example: M + enum: + - M + - F + required: + - nom + - prenoms + - date_naissance + - nom_commune_naissance + - sexe + required: + - est_boursier + - periode_versement_bourse + - etablissement_etudes + - echelon_bourse + - email + - identite + additionalProperties: false + links: + type: object + meta: + type: object + required: + - data + - links + - meta + '404': + description: Étudiant non identifié + content: + application/json: + examples: + entite_non_trouvee_26003: + value: + errors: + - code: '26003' + title: Entité non trouvée + detail: Aucun étudiant boursier n'a pu être trouvé avec les + critères de recherche fournis. Veuillez vérifier que l'identifiant + correspond au périmètre couvert par l'API. + source: + meta: + provider: CNOUS + summary: Entité non trouvée + description: Aucun étudiant boursier n'a pu être trouvé avec les + critères de recherche fournis. Veuillez vérifier que l'identifiant + correspond au périmètre couvert par l'API. + schema: + "$ref": "#/components/schemas/Error" + '502': + description: Erreur du fournisseur + content: + application/json: + examples: + provider_unknown_error: + value: + errors: + - code: '26999' + title: Erreur inconnue du fournisseur de données + detail: La réponse retournée par le fournisseur de données est + invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + source: + meta: + provider: CNOUS + summary: Erreur inconnue du fournisseur de données + description: La réponse retournée par le fournisseur de données + est invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + schema: + "$ref": "#/components/schemas/Error" + '504': + description: Erreur d'intermédiaire + content: + application/json: + examples: + timeout_error: + value: + errors: + - code: '26002' + title: Intermédiaire hors-délai + detail: Temps d’attente d’une réponse du fournisseur de données + écoulé. + source: + meta: + provider: CNOUS + summary: Intermédiaire hors-délai + description: Temps d’attente d’une réponse du fournisseur de données + écoulé. + provider_unavailable_error: + value: + errors: + - code: '26001' + title: Service non disponible + detail: Service du fournisseur de données temporairement indisponible + ou en maintenance. + source: + meta: + provider: CNOUS + summary: Service non disponible + description: Service du fournisseur de données temporairement indisponible + ou en maintenance. + network_error: + value: + errors: + - code: '00501' + title: Erreur réseau + detail: Problème de connexion au serveur distant. L'erreur peut + venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + source: + meta: + retry_in: 10 + summary: Erreur réseau + description: Problème de connexion au serveur distant. L'erreur + peut venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + dns_resolution_error: + value: + errors: + - code: '26004' + title: Erreur de résolution DNS + detail: Problème de résolution DNS de l'adresse du serveur + source: + meta: + provider: CNOUS + summary: Erreur de résolution DNS + description: Problème de résolution DNS de l'adresse du serveur + schema: + "$ref": "#/components/schemas/Error" + "/v3/france_travail/indemnites/identifiant": + get: + summary: Paiements versés par France Travail + tags: + - Paiements versés par France Travail + parameters: + - name: recipient + in: query + description: |- + "**Bénéficiaire de l’appel** + + SIRET de l’administration destinatrice des données." + example: '13002526500013' + required: true + schema: + type: string + - name: identifiant + in: query + description: Identifiant France Travail choisi par le particulier lors de + la création de son espace personnel en ligne. + example: jean.dupont33 + required: true + schema: + type: string + security: + - jwt_bearer_token: [] + description: Ensemble des paiements versés par France Travail au particulier + responses: + '401': + description: Non autorisé + content: + application/json: + examples: + invalid_token_error: + value: + errors: + - code: '00101' + title: Interdit + detail: Votre token n'est pas valide ou n'est pas renseigné + source: + parameter: token + meta: {} + summary: Interdit + description: Votre token n'est pas valide ou n'est pas renseigné + expired_token_error: + value: + errors: + - code: '00103' + title: Jeton expiré + detail: Votre token est expiré. Vous devez refaire une demande + source: + parameter: token + meta: {} + summary: Jeton expiré + description: Votre token est expiré. Vous devez refaire une demande + blacklisted_token_error: + value: + errors: + - code: '00105' + title: Jeton sur liste noire + detail: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver + un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + source: + parameter: token + meta: {} + summary: Jeton sur liste noire + description: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver un + jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + schema: + "$ref": "#/components/schemas/Error" + '403': + description: Accès interdit + content: + application/json: + examples: + insufficient_privileges_error: + value: + errors: + - code: '00100' + title: Privilèges insuffisants + detail: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + source: + parameter: token + meta: {} + summary: Privilèges insuffisants + description: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + schema: + "$ref": "#/components/schemas/Error" + '429': + description: Trop de requêtes + content: + application/json: + examples: + too_many_requests_error: + value: + errors: + - code: '00429' + title: Trop de requêtes + detail: Vous avez effectué trop de requêtes + source: + meta: {} + summary: Trop de requêtes + description: Vous avez effectué trop de requêtes + schema: + "$ref": "#/components/schemas/Error" + '200': + description: Indemnites trouvées + x-operationId: api_particulier_v3_france_travail_indemnites_with_identifiant + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + identifiant: + title: Nom d'utilisateur France Travail + type: string + description: Identifiant France Travail, tel qu'il a été renseigné + en paramètre d'appel. Cet identifiant est le nom d'utilisateur + tel que choisi par le particulier lors de la création de + son espace personnel en ligne. + example: jean.dupont33 + paiements: + title: Liste des paiements versés + description: Liste des paiements versés par FranceTravail + au particulier. + type: array + minItems: 1 + items: + title: Paiement + type: object + properties: + date_versement: + title: Date du paiement + type: string + example: '2021-01-01' + montant_total: + title: Montant total versé + description: Montant total du paiement. Il s'agit de + la somme des allocations, aides et autres paiements, + moins le prélèvement de l'impôt à la source. + type: number + example: 123.4 + montant_allocations: + title: Montant d'allocations + description: Montant du paiement, avant prélèvement + de l'impôt à la source, correspondant aux allocations + (allocation d'aide au retour à l'emploi, allocation + de sécurisation professionnelle, allocation de solidarité + spécifique, allocation pour les travailleurs indépendants, + Rémunération de formation France Travail, Rémunération + de fin de formation, allocation de fin de droit, allocation + d'accompagnement personnalisé, allocation de professionnalisation + et de solidarité, allocation décès, allocation contrat + engagement jeune). + type: number + example: 45.1 + montant_aides: + title: Montant d'aides + description: Montant du paiement, avant prélèvement + de l'impôt à la source, correspondant aux aides (aide + à la reprise et à la création d’entreprise, aide à + la mobilité, aide à la garde d'enfant pour parent + isolé, aide fin de droit, aide aux congés non payés, + aide à la valorisation des acquis par l'expérience, + aide du fond de sécurisation du secteur automobile, + aide ponctuelle jeune, aide régionale, aide aux demandeurs + d'emploi longue durée, aide exceptionnelle de solidarité, + Prime de reclassement). + type: number + example: 12.21 + montant_autres: + title: Montant des autres paiements + description: Montant du paiement, avant prélèvement + de l'impôt à la source, correspondant aux autres paiements + (prime de Noël, indemnité différentielle de reclassement, + acompte, avance, reversement). + type: number + example: 2.34 + required: + - identifiant + - paiements + additionalProperties: false + links: + type: object + meta: + type: object + required: + - data + - links + - meta + '404': + description: Non trouvée + content: + application/json: + examples: + entite_non_trouvee_24003: + value: + errors: + - code: '24003' + title: Entité non trouvée + detail: Aucune situation France Travail n'a pu être trouvée + avec les critères de recherche fournis. + source: + meta: + provider: France Travail + summary: Entité non trouvée + description: Aucune situation France Travail n'a pu être trouvée + avec les critères de recherche fournis. + schema: + "$ref": "#/components/schemas/Error" + '502': + description: Erreur du fournisseur + content: + application/json: + examples: + provider_unknown_error: + value: + errors: + - code: '24999' + title: Erreur inconnue du fournisseur de données + detail: La réponse retournée par le fournisseur de données est + invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + source: + meta: + provider: France Travail + summary: Erreur inconnue du fournisseur de données + description: La réponse retournée par le fournisseur de données + est invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + schema: + "$ref": "#/components/schemas/Error" + '504': + description: Erreur d'intermédiaire + content: + application/json: + examples: + timeout_error: + value: + errors: + - code: '24002' + title: Intermédiaire hors-délai + detail: Temps d’attente d’une réponse du fournisseur de données + écoulé. + source: + meta: + provider: France Travail + summary: Intermédiaire hors-délai + description: Temps d’attente d’une réponse du fournisseur de données + écoulé. + provider_unavailable_error: + value: + errors: + - code: '24001' + title: Service non disponible + detail: Service du fournisseur de données temporairement indisponible + ou en maintenance. + source: + meta: + provider: France Travail + summary: Service non disponible + description: Service du fournisseur de données temporairement indisponible + ou en maintenance. + network_error: + value: + errors: + - code: '00501' + title: Erreur réseau + detail: Problème de connexion au serveur distant. L'erreur peut + venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + source: + meta: + retry_in: 10 + summary: Erreur réseau + description: Problème de connexion au serveur distant. L'erreur + peut venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + dns_resolution_error: + value: + errors: + - code: '24004' + title: Erreur de résolution DNS + detail: Problème de résolution DNS de l'adresse du serveur + source: + meta: + provider: France Travail + summary: Erreur de résolution DNS + description: Problème de résolution DNS de l'adresse du serveur + schema: + "$ref": "#/components/schemas/Error" + "/v3/france_travail/statut/identifiant": + get: + summary: Statut demandeur d'emploi + tags: + - Statut demandeurs d'emploi + parameters: + - name: recipient + in: query + description: |- + "**Bénéficiaire de l’appel** + + SIRET de l’administration destinatrice des données." + example: '13002526500013' + required: true + schema: + type: string + - name: identifiant + in: query + description: Identifiant France Travail choisi par le particulier lors de + la création de son espace personnel en ligne. + example: jean.dupont33 + required: true + schema: + type: string + security: + - jwt_bearer_token: [] + description: | + Statut demandeur d'emploi, données relatives à l'inscription FranceTravail, ainsi que données d'identité de contact. + **Paramètres d'appel :** Nom d’utilisateur France Travail choisi par le particulier lors de la création de son espace personnel en ligne + **Données disponibles en bac à sable :** [liste](https://github.com/etalab/siade_staging_data/blob/develop/payloads/api_particulier_v2_pole_emploi_statut) + responses: + '401': + description: Non autorisé + content: + application/json: + examples: + invalid_token_error: + value: + errors: + - code: '00101' + title: Interdit + detail: Votre token n'est pas valide ou n'est pas renseigné + source: + parameter: token + meta: {} + summary: Interdit + description: Votre token n'est pas valide ou n'est pas renseigné + expired_token_error: + value: + errors: + - code: '00103' + title: Jeton expiré + detail: Votre token est expiré. Vous devez refaire une demande + source: + parameter: token + meta: {} + summary: Jeton expiré + description: Votre token est expiré. Vous devez refaire une demande + blacklisted_token_error: + value: + errors: + - code: '00105' + title: Jeton sur liste noire + detail: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver + un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + source: + parameter: token + meta: {} + summary: Jeton sur liste noire + description: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver un + jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + schema: + "$ref": "#/components/schemas/Error" + '403': + description: Accès interdit + content: + application/json: + examples: + insufficient_privileges_error: + value: + errors: + - code: '00100' + title: Privilèges insuffisants + detail: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + source: + parameter: token + meta: {} + summary: Privilèges insuffisants + description: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + schema: + "$ref": "#/components/schemas/Error" + '429': + description: Trop de requêtes + content: + application/json: + examples: + too_many_requests_error: + value: + errors: + - code: '00429' + title: Trop de requêtes + detail: Vous avez effectué trop de requêtes + source: + meta: {} + summary: Trop de requêtes + description: Vous avez effectué trop de requêtes + schema: + "$ref": "#/components/schemas/Error" + '200': + description: Statut trouvé + x-operationId: api_particulier_v3_france_travail_statut_with_identifiant + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + identifiant: + title: Nom d'utilisateur France Travail + type: string + description: | + Identifiant France Travail, tel qu'il a été renseigné + en paramètre d'appel. Cet identifiant est le nom d'utilisateur + tel que choisi par le particulier lors de la création de son + espace personnel en ligne. + example: martin.jacques + identite: + title: Identité + description: Donnée d'identité de l'utilisateur France Travail + type: object + properties: + civilite: + title: Civilité + description: Civilité du demandeur d'emploi, Madame ou + Monsieur. + type: string + example: M. + enum: + - MME + - M. + nom_naissance: + title: Nom de naissance + type: string + description: Nom de naissance du demandeur d'emploi. + example: MARTIN + nom_usage: + title: Nom d'usage + type: string + description: Nom d'usage du demandeur d'emploi. + nullable: true + example: + prenom: + title: Prénom + type: string + example: JACQUES + description: Prénom ddu demandeur d'emploi, limité à 13 + caractères + sexe: + title: Sexe + type: string + description: Sexe du demandeur d'emploi. + example: Masculin + date_naissance: + title: Date de naissance + format: date + type: string + description: Date de naissance du demandeur d'emploi au + format YYYY-MM-DD. + example: '1995-02-02' + required: + - civilite + - nom_naissance + - nom_usage + - prenom + - sexe + - date_naissance + contact: + title: Contact + description: Données de contact de l'utilisateur France Travail. + type: object + properties: + telephone: + title: Téléphone principal + type: string + description: Numéro de téléphone principal du demandeur + d'emploi. + example: '0636676767' + telephone2: + title: Téléphone secondaire + type: string + description: Numéro de téléphone secondaire du demandeur + d'emploi. + nullable: true + example: '1122334455' + email: + title: E-mail + type: string + nullable: true + description: Adresse e-mail du demandeur d'emploi. + example: martin.jacques@france.fr + required: + - telephone + - telephone2 + - email + adresse: + title: Adresse + type: object + description: Adresse du demandeur d'emploi, déclarée par le + particulier lors de son inscription à France Travail ou + suite à une déclaration de changement d’adresse. + properties: + code_postal: + type: string + title: Code postal + example: '75001' + code_cog_insee_commune: + title: Code COG Insee de la commune + type: string + example: '75101' + localite: + title: Localité (Code postal et nom de la commune) + type: string + example: 75001 Paris + ligne_voie: + title: Voie + type: string + example: 21 RUE DES MARMOTS + ligne_complement_destinataire: + title: Complément destinataire + type: string + nullable: true + example: Appartement 42 + ligne_complement_adresse: + title: Complément d'adresse + type: string + nullable: true + example: + ligne_complement_distribution: + title: Complément distribution + type: string + nullable: true + ligne_nom: + title: Nom du destinataire + type: string + example: MARTIN + required: + - code_postal + - code_cog_insee_commune + - localite + - ligne_voie + - ligne_complement_destinataire + - ligne_complement_adresse + - ligne_complement_distribution + - ligne_nom + inscription: + title: Inscription FranceTravail + description: Données relatives à l'inscription de l'utilisateur + à France Travail. + type: object + properties: + date_debut: + title: Date d'inscription + format: date + type: string + description: Date d'inscription à France Travail au format + YYYY-MM-DD. + example: '2021-01-07' + date_fin: + title: Date de cessation d'inscription + description: Date de cessation d'inscription à France + Travail au format YYYY-MM-DD. + type: string + format: date + nullable: true + example: '2023-03-12' + categorie: + title: Catégorie d'inscription + description: "Catégorie de l'inscription de l'utilisateur + à France Travail. La liste des catégories possibles + est la suivante : \n - 1 : PERSONNE SANS EMPLOI DISPONIBLE + DUREE INDETERMINEE PLEIN TPS\n - 2 : PERSONNE SANS + EMPLOI DISPONIBLE DUREE INDETERMINEE PARTIEL\n - 3 + : PERSONNE SANS EMPLOI DISPONIBLE DUREE DETERMINEE OU + SAISON\n - 4 : PERSONNE SANS EMPLOI NON DISPONIBLE + IMMEDIATEMENT\n - 5 : PERSONNE POURVUE D'UN EMPLOI + A LA RECHERCHE D'UN AUTRE\n" + type: object + properties: + code: + title: Code + description: 'Code de la catégorie d''inscription + du particulier à France Travail. + + ' + type: integer + example: 1 + enum: + - 1 + - 2 + - 3 + - 4 + - 5 + libelle: + title: Libellé + description: Libellé de la catégorie d'inscription + du particulier à France Travail. + type: string + example: PERSONNE SANS EMPLOI DISPONIBLE DUREE INDETERMINEE + PLEIN TPS + enum: + - PERSONNE SANS EMPLOI DISPONIBLE DUREE INDETERMINEE + PLEIN TPS + - PERSONNE SANS EMPLOI DISPONIBLE DUREE INDETERMINEE + PARTIEL + - PERSONNE SANS EMPLOI DISPONIBLE DUREE DETERMINEE + OU SAISON + - PERSONNE SANS EMPLOI NON DISPONIBLE IMMEDIATEMENT + - PERSONNE POURVUE D'UN EMPLOI A LA RECHERCHE D'UN + AUTRE + required: + - code + - libelle + code_certification_cnav: + title: Code du statut de certification d'identité CNAV + type: string + description: | + France Travail dépend d'un flux de certification d'identité émis par la CNAV, un particulier peut avoir été + certifié ou non. La signification des codes est la suivante : + - VC IDENTITE CERTIFIEE + - IC : IDENTITE ASSIMILEE CERTIFIEE + - PC : IDENTITE CERTIFIEE PARTIELLEMENT + Sont considérés comme non-certifiés : + - AC : ATTENTE TRAITEMENT RETOUR CNAV + - DC : DEMANDE CERTIF. ENVOYEE + - EC : ECHEC DE CERTIFICATION CNAV + - RC : REFUS PROPOSITION DE CERTIFICATION + - null : IDENTITE NON CERTIFIEE + example: VC + enum: + - VC + - IC + - PC + - AC + - DC + - RC + - + required: + - date_debut + - date_fin + - categorie + - code_certification_cnav + required: + - identifiant + - identite + - contact + - adresse + - inscription + additionalProperties: false + links: + type: object + meta: + type: object + required: + - data + - links + - meta + '404': + description: Non trouvée + content: + application/json: + examples: + entite_non_trouvee_24003: + value: + errors: + - code: '24003' + title: Entité non trouvée + detail: Aucune situation France Travail n'a pu être trouvée + avec les critères de recherche fournis. + source: + meta: + provider: France Travail + summary: Entité non trouvée + description: Aucune situation France Travail n'a pu être trouvée + avec les critères de recherche fournis. + schema: + "$ref": "#/components/schemas/Error" + '502': + description: Erreur du fournisseur + content: + application/json: + examples: + provider_unknown_error: + value: + errors: + - code: '24999' + title: Erreur inconnue du fournisseur de données + detail: La réponse retournée par le fournisseur de données est + invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + source: + meta: + provider: France Travail + summary: Erreur inconnue du fournisseur de données + description: La réponse retournée par le fournisseur de données + est invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + schema: + "$ref": "#/components/schemas/Error" + '504': + description: Erreur d'intermédiaire + content: + application/json: + examples: + timeout_error: + value: + errors: + - code: '24002' + title: Intermédiaire hors-délai + detail: Temps d’attente d’une réponse du fournisseur de données + écoulé. + source: + meta: + provider: France Travail + summary: Intermédiaire hors-délai + description: Temps d’attente d’une réponse du fournisseur de données + écoulé. + provider_unavailable_error: + value: + errors: + - code: '24001' + title: Service non disponible + detail: Service du fournisseur de données temporairement indisponible + ou en maintenance. + source: + meta: + provider: France Travail + summary: Service non disponible + description: Service du fournisseur de données temporairement indisponible + ou en maintenance. + network_error: + value: + errors: + - code: '00501' + title: Erreur réseau + detail: Problème de connexion au serveur distant. L'erreur peut + venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + source: + meta: + retry_in: 10 + summary: Erreur réseau + description: Problème de connexion au serveur distant. L'erreur + peut venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + dns_resolution_error: + value: + errors: + - code: '24004' + title: Erreur de résolution DNS + detail: Problème de résolution DNS de l'adresse du serveur + source: + meta: + provider: France Travail + summary: Erreur de résolution DNS + description: Problème de résolution DNS de l'adresse du serveur + schema: + "$ref": "#/components/schemas/Error" + "/v3/men/scolarites/identite": + get: + summary: Statut élève scolarisé et boursier + tags: + - Statut élève scolarisé et boursier + parameters: + - name: recipient + in: query + description: |- + "**Bénéficiaire de l’appel** + + SIRET de l’administration destinatrice des données." + example: '13002526500013' + required: true + schema: + type: string + - name: nomNaissance + in: query + description: "**Nom de naissance, également appelé nom de famille**. \n\nLe + nom de naissance est indiqué sur l'acte de naissance, de mariage, sur le + livret de famille, etc. Le nom de famille/naissance figure toujours sur + la pièce d'identité en premier, avant le nom d'usage si le particulier en + a un. \n\nEn cas de changement de nom de naissance, une mention avec le + nouveau nom de famille est inscrite sur l'acte de naissance. Pour appeler + l'API, le nom de naissance/famille nécessaire est bien le nom de famille + modifié." + example: DURANT + required: true + schema: + type: string + - name: prenoms[] + in: query + schema: + type: array + minItems: 1 + maxItems: 3 + items: + type: string + example: + - PIERRE + - RICHARD + description: "**Liste des prénoms**. \n\nFournir plusieurs prénoms maximise + les chances que l'API retrouve le particulier car cela permet de limiter + le risque d’homonymie." + required: true + - name: sexeEtatCivil + in: query + schema: + type: string + enum: + - M + - F + description: "**Sexe de la personne tel qu'indiqué sur les actes d'état civil**, + comme par exemple l'acte de naissance ou de mariage. \n\nDans la majorité + des cas, il s'agit également de la mention indiquée sur la pièce d'identité + et le passeport. Cette mention peut être masculin ('M') ou féminin ('F'). + \nDans le cas d'un particulier ayant demandé une modification de sa mention + de sexe à l'état civil, le changement est indiqué en marge de l'acte de + naissance une fois la décision rendue. Le changement intervient sur les + titres d'identité seulement si le particulier en demande le renouvellement." + example: M + required: true + - name: anneeDateNaissance + in: query + description: "**Année de naissance**. \n\nPour un particulier né en France, + dans le cadre d'un appel à l'API avec l'utilisation du paramètre 'nomCommuneNaissance', + ce paramètre est obligatoire (ainsi que le paramètre 'codeCogInseeDepartementNaissance') + afin de retrouver le code COG de la commune de naissance." + example: 1990 + required: true + schema: + type: integer + - name: moisDateNaissance + in: query + description: "**Mois de naissance**." + example: 1 + required: true + schema: + type: integer + - name: jourDateNaissance + in: query + description: "**Jour de naissance**." + example: 1 + required: true + schema: + type: integer + - name: codeEtablissement + in: query + description: | + Code d'unité administrative immatriculée (code UAI) de l'établissement où est scolarisé l'élève. Ce code unique inscrit au répertoire national des établissements est composé de 7 chiffres et d'une lettre ; les trois premiers chiffres correspondent au numéro de département de l'établissement. + + Pour retrouver facilement le code UAI d'un établissement à partir d'informations plus facilement connues des usagers (commune, code postal, etc.), vous pouvez utiliser l'[API "Annuaire de l'éducation nationale"](https://api.gouv.fr/les-api/api-annuaire-education). + + ⚠️ L'établissement 0861288H (CNED Direction générale) n'existe pas dans l'API annuaire de l'éducation nationale, il faudra donc compléter la liste des établissements avec une ligne CNED à laquelle sera associée le code UAI qui sera en passé en entrée. + example: 0210015C + required: true + schema: + type: string + - name: anneeScolaire + in: query + description: 'Année scolaire recherchée au format AAAA-AAAA ou AAAA. Les informations + connues par l''API concerne surtout l''année en cours et parfois l''année + scolaire à venir. Pour en savoir plus consulter la fiche métier : https://particulier.api.gouv.fr/catalogue/education_nationale/statut_eleve_scolarise#faq_entry_answer_0_api_particulier_endpoint_education_nationale_statut_eleve_scolarise.' + example: 2022-2023 + required: true + schema: + type: string + security: + - jwt_bearer_token: [] + description: Statut scolarisé et statut boursier d'un élève du primaire, collège + ou lycée. + responses: + '401': + description: Non autorisé + content: + application/json: + examples: + invalid_token_error: + value: + errors: + - code: '00101' + title: Interdit + detail: Votre token n'est pas valide ou n'est pas renseigné + source: + parameter: token + meta: {} + summary: Interdit + description: Votre token n'est pas valide ou n'est pas renseigné + expired_token_error: + value: + errors: + - code: '00103' + title: Jeton expiré + detail: Votre token est expiré. Vous devez refaire une demande + source: + parameter: token + meta: {} + summary: Jeton expiré + description: Votre token est expiré. Vous devez refaire une demande + blacklisted_token_error: + value: + errors: + - code: '00105' + title: Jeton sur liste noire + detail: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver + un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + source: + parameter: token + meta: {} + summary: Jeton sur liste noire + description: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver un + jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + schema: + "$ref": "#/components/schemas/Error" + '403': + description: Accès interdit + content: + application/json: + examples: + insufficient_privileges_error: + value: + errors: + - code: '00100' + title: Privilèges insuffisants + detail: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + source: + parameter: token + meta: {} + summary: Privilèges insuffisants + description: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + schema: + "$ref": "#/components/schemas/Error" + '429': + description: Trop de requêtes + content: + application/json: + examples: + too_many_requests_error: + value: + errors: + - code: '00429' + title: Trop de requêtes + detail: Vous avez effectué trop de requêtes + source: + meta: {} + summary: Trop de requêtes + description: Vous avez effectué trop de requêtes + schema: + "$ref": "#/components/schemas/Error" + '200': + description: Scolarité trouvée + x-operationId: api_particulier_v3_men_scolarites_with_civility + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + identite: + title: Données d'identité de l'élève passées en paramètres + d'appel + description: Les informations d'identité retournées ici sont + issues de la base de données des établissemets scolaires + où les élèves sont inscrits et proviennent des pièces d'identité + que les parents doivent fournir pour inscrire leur enfant. + type: object + properties: + nom: + title: Nom + description: Nom de l'élève. + type: string + example: Martin + prenom: + title: Prénom + description: Prénom de l'élève. + type: string + example: Justine + sexe: + title: Sexe + description: Sexe de l'élève, masculin ou féminin. + type: string + example: F + enum: + - M + - F + date_naissance: + title: Date de naissance + description: Date de naissance de l'élève au format AAAA-MM-JJ + type: string + example: '2000-01-20' + required: + - nom + - prenom + - sexe + - date_naissance + annee_scolaire: + title: Année scolaire + description: Année scolaire de l'élève au format AAAA-AAAA. + type: string + pattern: "^\\d{4}$|^\\d{4}-\\d{4}$" + example: 2022-2023 + est_scolarise: + title: Statut scolarisé + description: Indique si l'élève est scolarisé dans un établissement. + type: boolean + example: true + statut_eleve: + title: Statut de l'élève + description: | + Indique le statut sous lequel l'élève est scolarisé dans l'établissement. Les valeurs sont susceptibles d'évoluer : + + - ST : Scolaire, il s'agit du statut de base renvoyé pour près de 95% des élèves. + - AP : Apprenti + - CQ : Contrat de qualification + - FC : Formation continue + - ED : Enseignement à distance + - IN : Candidat individuel + - FQ : Stagiaire de la formation Professionnelle + - SC : Scolaire ou formation initiale + - CP : Contrat de professionnalisation. + - NC : Non connu ou non communiqué. + type: object + properties: + code: + title: Code + description: Code du statut sous lequel l'élève est scolarisé + dans l'établissement. + type: string + example: ST + libelle: + title: Libellé + description: Libellé du statut sous lequel l'élève est + scolarisé dans l'établissement. + type: string + example: SCOLAIRE + required: + - code + - libelle + est_boursier: + title: Statut boursier + description: | + Indique si l'élève est boursier dans un établissement. Seuls les collègiens et lycéens peuvent être boursiers. + + ⚠️ Si le statut boursier est à "false" avant mi-octobre, cela ne signifie pas forcément que l'élève n'est pas boursier. Il peut s'agir d'un faux négatif lié à une absence de l'information en base. Pour en savoir plus consulter la fiche métier : https://particulier.api.gouv.fr/catalogue/education_nationale/statut_eleve_scolarise#faq_entry_answer_1_api_particulier_endpoint_education_nationale_statut_eleve_scolarise. + + Ce champs est à null lorsque l'on ne sait pas si l'élève est boursier ou non. + type: boolean + example: true + nullable: true + echelon_bourse: + title: Échelon de la bourse + description: | + Ce champ indique l'échelon de la bourse de l'élève. + + Il existe trois échelons de bourses pour les collégiens (1 à 3) et six échelons pour les lycéens (1 à 6), correspondant aux montants reçus par l'élève pour l'année scolaire. Pour en savoir plus, consulter la FAQ : https://particulier.api.gouv.fr/catalogue/education_nationale/statut_eleve_scolarise#faq_entry_answer_2_api_particulier_endpoint_education_nationale_statut_eleve_scolarise. + + Ce champ est à "null" quand "est_boursier" est "false"." + type: integer + example: 1 + nullable: true + enum: + - + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + code_etablissement: + title: Code UAI de l'établissement + description: | + Code d'unité administrative immatriculée (code UAI) de l'établissement où est scolarisé l'élève. Ce code unique inscrit au répertoire national des établissements est composé de 7 chiffres et d'une lettre ; les trois premiers chiffres correspondent au numéro de département de l'établissement. + + Pour retrouver le nom de l'établissement, vous pouvez utiliser l'[API "Annuaire de l'éducation nationale"](https://api.gouv.fr/les-api/api-annuaire-education) ou le site https://annuaire-education.fr. + type: string + pattern: "^\\d{7}\\w$" + example: 0210015C + required: + - identite + - annee_scolaire + - est_scolarise + - statut_eleve + - est_boursier + - echelon_bourse + - code_etablissement + additionalProperties: false + links: + type: object + meta: + type: object + required: + - data + - links + - meta + '404': + description: Non trouvée + content: + application/json: + examples: + entite_non_trouvee_30003: + value: + errors: + - code: '30003' + title: Entité non trouvée + detail: Aucun élève n'a pu être trouvé avec les critères de + recherche fournis. + source: + meta: + provider: MEN + summary: Entité non trouvée + description: Aucun élève n'a pu être trouvé avec les critères de + recherche fournis. + schema: + "$ref": "#/components/schemas/Error" + '502': + description: Erreur du fournisseur + content: + application/json: + examples: + provider_unknown_error: + value: + errors: + - code: '30999' + title: Erreur inconnue du fournisseur de données + detail: La réponse retournée par le fournisseur de données est + invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + source: + meta: + provider: MEN + summary: Erreur inconnue du fournisseur de données + description: La réponse retournée par le fournisseur de données + est invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + schema: + "$ref": "#/components/schemas/Error" + '504': + description: Erreur d'intermédiaire + content: + application/json: + examples: + timeout_error: + value: + errors: + - code: '30002' + title: Intermédiaire hors-délai + detail: Temps d’attente d’une réponse du fournisseur de données + écoulé. + source: + meta: + provider: MEN + summary: Intermédiaire hors-délai + description: Temps d’attente d’une réponse du fournisseur de données + écoulé. + provider_unavailable_error: + value: + errors: + - code: '30001' + title: Service non disponible + detail: Service du fournisseur de données temporairement indisponible + ou en maintenance. + source: + meta: + provider: MEN + summary: Service non disponible + description: Service du fournisseur de données temporairement indisponible + ou en maintenance. + network_error: + value: + errors: + - code: '00501' + title: Erreur réseau + detail: Problème de connexion au serveur distant. L'erreur peut + venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + source: + meta: + retry_in: 10 + summary: Erreur réseau + description: Problème de connexion au serveur distant. L'erreur + peut venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + dns_resolution_error: + value: + errors: + - code: '30004' + title: Erreur de résolution DNS + detail: Problème de résolution DNS de l'adresse du serveur + source: + meta: + provider: MEN + summary: Erreur de résolution DNS + description: Problème de résolution DNS de l'adresse du serveur + schema: + "$ref": "#/components/schemas/Error" + "/v3/mesri/statut_etudiant/identite": + get: + summary: Statut étudiant + tags: + - Statut étudiant + parameters: + - name: recipient + in: query + description: |- + "**Bénéficiaire de l’appel** + + SIRET de l’administration destinatrice des données." + example: '13002526500013' + required: true + schema: + type: string + - name: nomNaissance + in: query + description: "**Nom de naissance, également appelé nom de famille**. \n\nLe + nom de naissance est indiqué sur l'acte de naissance, de mariage, sur le + livret de famille, etc. Le nom de famille/naissance figure toujours sur + la pièce d'identité en premier, avant le nom d'usage si le particulier en + a un. \n\nEn cas de changement de nom de naissance, une mention avec le + nouveau nom de famille est inscrite sur l'acte de naissance. Pour appeler + l'API, le nom de naissance/famille nécessaire est bien le nom de famille + modifié." + example: DURANT + required: true + schema: + type: string + - name: prenoms[] + in: query + schema: + type: array + minItems: 1 + maxItems: 1 + items: + type: string + example: + - PIERRE + - RICHARD + description: "**Liste des prénoms**. \n\nDans le cadre de cette API, il n'est + possible de fournir qu'un seul prenom." + required: true + - name: anneeDateNaissance + in: query + description: "**Année de naissance**. \n\nPour un particulier né en France, + dans le cadre d'un appel à l'API avec l'utilisation du paramètre 'nomCommuneNaissance', + ce paramètre est obligatoire (ainsi que le paramètre 'codeCogInseeDepartementNaissance') + afin de retrouver le code COG de la commune de naissance." + example: 1990 + required: true + schema: + type: integer + - name: moisDateNaissance + in: query + description: "**Mois de naissance**." + example: 1 + required: true + schema: + type: integer + - name: jourDateNaissance + in: query + description: "**Jour de naissance**." + example: 1 + required: true + schema: + type: integer + - name: sexeEtatCivil + in: query + schema: + type: string + enum: + - M + - F + description: "**Sexe de la personne tel qu'indiqué sur les actes d'état civil**, + comme par exemple l'acte de naissance ou de mariage. \n\nDans la majorité + des cas, il s'agit également de la mention indiquée sur la pièce d'identité + et le passeport. Cette mention peut être masculin ('M') ou féminin ('F'). + \nDans le cas d'un particulier ayant demandé une modification de sa mention + de sexe à l'état civil, le changement est indiqué en marge de l'acte de + naissance une fois la décision rendue. Le changement intervient sur les + titres d'identité seulement si le particulier en demande le renouvellement." + example: M + required: true + - name: codeCogInseeCommuneNaissance + in: query + schema: + type: string + minLength: 5 + maxLength: 5 + example: '08480' + description: "**Code Insee à 5 chiffres de la commune de naissance**. \n\nPour + retrouver un particulier né en France, il est nécessaire d'indiquer sa commune + de naissance. Ce paramètre est une des deux options disponibles pour renseigner + la commune de naissance. En l'absence de l'utilisation de la seconde option + (triplet 'nomCommuneNaissance', 'anneeDateNaissance', 'codeInseeDepartementNaissance').\n\nNe + pas remplir si la personne est née à l'étranger." + required: false + - name: nomCommuneNaissance + in: query + schema: + type: string + minLength: 1 + example: Gennevilliers + description: "**Nom en toute lettre de la commune de naissance**. \n\nPour + retrouver un particulier né en France, il est nécessaire d'indiquer sa commune + de naissance. Ce paramètre est une des deux options disponibles pour renseigner + la commune de naissance. En l'absence de l'utilisation du 'codeCogInseeCommuneNaissance', + ce paramètre est obligatoire si la personne est née en France ; il doit + être obligatoirement accompagné des paramètres 'codeCogInseeDepartementNaissance' + et 'anneeDateNaissance'.\n\nNe pas remplir si la personne est née à l'étranger." + required: false + - name: codeCogInseeDepartementNaissance + in: query + schema: + type: string + minLength: 2 + maxLength: 3 + example: '92' + description: "**Code INSEE du département de naissance**. \n\nPour retrouver + un particulier né en France, il est nécessaire d'indiquer sa commune de + naissance. Ce paramètre fait partie d'une des deux options disponibles pour + renseigner la commune de naissance. Lorsque le paramètre 'nomCommuneNaissance' + est utilisé, ce paramètre est obligatoire si la personne est née en France + et permet de retrouver le code COG avec le paramètre 'anneeDateNaissance'.\n\nNe + pas remplir si la personne est née à l'étranger." + required: false + security: + - jwt_bearer_token: [] + description: Admissions et inscriptions d'un étudiant aux établissements d'enseignement + supérieur. + responses: + '401': + description: Non autorisé + content: + application/json: + examples: + invalid_token_error: + value: + errors: + - code: '00101' + title: Interdit + detail: Votre token n'est pas valide ou n'est pas renseigné + source: + parameter: token + meta: {} + summary: Interdit + description: Votre token n'est pas valide ou n'est pas renseigné + expired_token_error: + value: + errors: + - code: '00103' + title: Jeton expiré + detail: Votre token est expiré. Vous devez refaire une demande + source: + parameter: token + meta: {} + summary: Jeton expiré + description: Votre token est expiré. Vous devez refaire une demande + blacklisted_token_error: + value: + errors: + - code: '00105' + title: Jeton sur liste noire + detail: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver + un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + source: + parameter: token + meta: {} + summary: Jeton sur liste noire + description: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver un + jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + schema: + "$ref": "#/components/schemas/Error" + '403': + description: Accès interdit + content: + application/json: + examples: + insufficient_privileges_error: + value: + errors: + - code: '00100' + title: Privilèges insuffisants + detail: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + source: + parameter: token + meta: {} + summary: Privilèges insuffisants + description: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + schema: + "$ref": "#/components/schemas/Error" + '429': + description: Trop de requêtes + content: + application/json: + examples: + too_many_requests_error: + value: + errors: + - code: '00429' + title: Trop de requêtes + detail: Vous avez effectué trop de requêtes + source: + meta: {} + summary: Trop de requêtes + description: Vous avez effectué trop de requêtes + schema: + "$ref": "#/components/schemas/Error" + '200': + description: Étudiant identifié + x-operationId: api_particulier_v3_mesri_statut_etudiant_with_civility + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + admissions: + title: Admissions de l'étudiant dans un ou plusieurs établissements + description: "Liste des admissions de l'étudiant dans un ou + plusieurs établissements d'enseignement supérieur pour l'année + en cours. \n\nChaque objet listé correspond à un établissement + dans lequel l'étudiant est au minimum admis. C'est-à-dire + que l'étudiant est au minimum pré-inscrit dans l'établissement.\n\nSi + l'étudiant est inscrit dans l'établissement (procédure complète + et règlement des droits d'inscription terminés), la clé + est_inscrit sera alors à true pour l'objet concerné.\n" + type: array + items: + type: object + properties: + date_debut: + title: Date de début de période d'études + type: string + format: date + description: Date de début de la période d'études dans + l'établissement. + example: '2022-09-01' + date_fin: + title: Date de fin de période d'études + type: string + format: date + description: Date de fin de la période d'étude dans + l'établissement. + example: '2023-08-31' + est_inscrit: + title: Statut étudiant inscrit + type: boolean + example: true + enum: + - true + - false + description: | + Indique que l'étudiant est inscrit dans l'établissement. + + Si le champ est à false, c'est que l'étudiant n'est pas inscrit, mais seulement admis dans l'établissement. C'est-à-dire que l'étudiant est pré-inscrit dans l'établissement mais que la procédure complète d'inscription et le règlement des droits d'inscription ne sont pas terminés. Les étudiants admis deviennent inscrits, une fois leurs droits d'inscription régularisés (paiement des droits, premier versement des droits ou acquittement des droits selon la situation de l'étudiant et les règles de l'établissement.). Tous les étudiants admis ne seront pas forcément de futurs étudiants inscrits dans l'établissement. + regime_formation: + title: Régime de formation + description: "Régime de formation de l'étudiant. La + liste des régimes possibles est la suivante : \n - + RF1 : formation initiale\n - RF2 : formation initiale + hors apprentissage\n - RF3 : reprise d'études non + financée sans convention\n - RF4 : contrat d'apprentissage\n + \ - RF5 : formation continue\n - RF6 : formation + continue hors contrat professionnel\n - RF7 : contrat + de professionnalisation\n" + type: object + properties: + libelle: + title: Libellé + type: string + description: 'Libellé de la formation de l''étudiant. + + ' + example: formation initiale + enum: + - formation initiale + - formation initiale hors apprentissage + - reprise d'études non financée sans convention + - contrat d'apprentissage + - formation continue + - formation continue hors contrat professionnel + - contrat de professionnalisation + code: + title: Code + type: string + description: 'Code de la formation correspondant + au régime. C''est un code technique pour exploiter + différents mécanismes indépendament du label du + régime. + + ' + example: RF1 + enum: + - RF1 + - RF2 + - RF3 + - RF4 + - RF5 + - RF6 + - RF7 + code_cog_insee_commune: + title: Commune de l'établissement d'études + type: string + description: Code Insee à 5 chiffres de la commune de + l'établissement d'études de l'étudiant. + example: '29085' + etablissement_etudes: + title: Établissement d'études + description: "Code UAI et libellé de l'établissement + d'enseignement supérieur dans lequel l'étudiant est + admis. \n\nPour retrouver d'autres informations sur + l'établissement, vous pouvez utiliser l'[API \"Annuaire + de l'éducation nationale\"](https://api.gouv.fr/les-api/api-annuaire-education) + ou le site https://annuaire-education.fr.\n" + type: object + properties: + uai: + title: Code UAI + type: string + description: 'Code d''unité administrative immatriculée + (code UAI) de l''établissement où est scolarisé + l''élève. Ce code unique inscrit au répertoire + national des établissements est composé de 7 chiffres + et d''une lettre ; les trois premiers chiffres + correspondent au numéro de département de l''établissement. + + ' + pattern: "^\\d{7}\\w$" + example: 0011402U + nom: + title: Appelation officielle + type: string + description: Appelation officielle de l'établissement + associée au code UAI. + example: EGC AIN BOURG EN BRESSE EC GESTION ET COMMERCE + (01000) + identite: + title: Données d'identité de l'étudiant + description: Données d'identité de l'étudiant corrigées et + certifiées via l'API Ines qui croise l'état civil et le + numéro INE de l'étudiant. + type: object + properties: + nom_naissance: + title: Nom de naissance + type: string + description: "Nom de naissance de l'étudiant. Il s'agit + du nom de famille tel qu'indiqué sur l'acte de naissance, + de mariage, sur le livret de famille, etc. Ce nom figure + toujours sur la pièce d'identité en premier, avant le + nom d'usage si le particulier en a un. \n\nEn cas de + changement de nom de naissance, une mention avec le + nouveau nom de famille est inscrite sur l'acte de naissance.\n" + example: Moustaki + prenom: + title: Prénom + type: string + description: Prénom de l'étudiant. + example: Georges + date_naissance: + title: Date de naissance + type: string + format: date + description: Date de naissance de l'étudiant. + example: '1992-11-29' + required: + - nom_naissance + - prenom + - date_naissance + required: + - admissions + - identite + additionalProperties: false + links: + type: object + meta: + type: object + required: + - data + - links + - meta + '404': + description: Étudiant non identifié + content: + application/json: + examples: + entite_non_trouvee_25003: + value: + errors: + - code: '25003' + title: Entité non trouvée + detail: Aucun étudiant n'a pu être trouvé avec les critères + de recherche fournis. + source: + meta: + provider: MESRI + summary: Entité non trouvée + description: Aucun étudiant n'a pu être trouvé avec les critères + de recherche fournis. + schema: + "$ref": "#/components/schemas/Error" + '502': + description: Erreur du fournisseur + content: + application/json: + examples: + provider_unknown_error: + value: + errors: + - code: '25999' + title: Erreur inconnue du fournisseur de données + detail: La réponse retournée par le fournisseur de données est + invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + source: + meta: + provider: MESRI + summary: Erreur inconnue du fournisseur de données + description: La réponse retournée par le fournisseur de données + est invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + schema: + "$ref": "#/components/schemas/Error" + '504': + description: Erreur d'intermédiaire + content: + application/json: + examples: + timeout_error: + value: + errors: + - code: '25002' + title: Intermédiaire hors-délai + detail: Temps d’attente d’une réponse du fournisseur de données + écoulé. + source: + meta: + provider: MESRI + summary: Intermédiaire hors-délai + description: Temps d’attente d’une réponse du fournisseur de données + écoulé. + provider_unavailable_error: + value: + errors: + - code: '25001' + title: Service non disponible + detail: Service du fournisseur de données temporairement indisponible + ou en maintenance. + source: + meta: + provider: MESRI + summary: Service non disponible + description: Service du fournisseur de données temporairement indisponible + ou en maintenance. + network_error: + value: + errors: + - code: '00501' + title: Erreur réseau + detail: Problème de connexion au serveur distant. L'erreur peut + venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + source: + meta: + retry_in: 10 + summary: Erreur réseau + description: Problème de connexion au serveur distant. L'erreur + peut venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + dns_resolution_error: + value: + errors: + - code: '25004' + title: Erreur de résolution DNS + detail: Problème de résolution DNS de l'adresse du serveur + source: + meta: + provider: MESRI + summary: Erreur de résolution DNS + description: Problème de résolution DNS de l'adresse du serveur + schema: + "$ref": "#/components/schemas/Error" + "/v3/mesri/statut_etudiant/france_connect": + get: + summary: Statut étudiant + tags: + - Statut étudiant + parameters: + - name: recipient + in: query + description: |- + "**Bénéficiaire de l’appel** + + SIRET de l’administration destinatrice des données." + example: '13002526500013' + required: true + schema: + type: string + security: + - jwt_bearer_token: [] + description: Admissions et inscriptions d'un étudiant aux établissements d'enseignement + supérieur. + responses: + '403': + description: Accès interdit + content: + application/json: + examples: + insufficient_privileges_error: + value: + errors: + - code: '00100' + title: Privilèges insuffisants + detail: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + source: + parameter: token + meta: {} + summary: Privilèges insuffisants + description: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + schema: + "$ref": "#/components/schemas/Error" + '200': + description: Étudiant identifié + x-operationId: api_particulier_v3_mesri_statut_etudiant_with_france_connect + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + admissions: + title: Admissions de l'étudiant dans un ou plusieurs établissements + description: "Liste des admissions de l'étudiant dans un ou + plusieurs établissements d'enseignement supérieur pour l'année + en cours. \n\nChaque objet listé correspond à un établissement + dans lequel l'étudiant est au minimum admis. C'est-à-dire + que l'étudiant est au minimum pré-inscrit dans l'établissement.\n\nSi + l'étudiant est inscrit dans l'établissement (procédure complète + et règlement des droits d'inscription terminés), la clé + est_inscrit sera alors à true pour l'objet concerné.\n" + type: array + items: + type: object + properties: + date_debut: + title: Date de début de période d'études + type: string + format: date + description: Date de début de la période d'études dans + l'établissement. + example: '2022-09-01' + date_fin: + title: Date de fin de période d'études + type: string + format: date + description: Date de fin de la période d'étude dans + l'établissement. + example: '2023-08-31' + est_inscrit: + title: Statut étudiant inscrit + type: boolean + example: true + enum: + - true + - false + description: | + Indique que l'étudiant est inscrit dans l'établissement. + + Si le champ est à false, c'est que l'étudiant n'est pas inscrit, mais seulement admis dans l'établissement. C'est-à-dire que l'étudiant est pré-inscrit dans l'établissement mais que la procédure complète d'inscription et le règlement des droits d'inscription ne sont pas terminés. Les étudiants admis deviennent inscrits, une fois leurs droits d'inscription régularisés (paiement des droits, premier versement des droits ou acquittement des droits selon la situation de l'étudiant et les règles de l'établissement.). Tous les étudiants admis ne seront pas forcément de futurs étudiants inscrits dans l'établissement. + regime_formation: + title: Régime de formation + description: "Régime de formation de l'étudiant. La + liste des régimes possibles est la suivante : \n - + RF1 : formation initiale\n - RF2 : formation initiale + hors apprentissage\n - RF3 : reprise d'études non + financée sans convention\n - RF4 : contrat d'apprentissage\n + \ - RF5 : formation continue\n - RF6 : formation + continue hors contrat professionnel\n - RF7 : contrat + de professionnalisation\n" + type: object + properties: + libelle: + title: Libellé + type: string + description: 'Libellé de la formation de l''étudiant. + + ' + example: formation initiale + enum: + - formation initiale + - formation initiale hors apprentissage + - reprise d'études non financée sans convention + - contrat d'apprentissage + - formation continue + - formation continue hors contrat professionnel + - contrat de professionnalisation + code: + title: Code + type: string + description: 'Code de la formation correspondant + au régime. C''est un code technique pour exploiter + différents mécanismes indépendament du label du + régime. + + ' + example: RF1 + enum: + - RF1 + - RF2 + - RF3 + - RF4 + - RF5 + - RF6 + - RF7 + code_cog_insee_commune: + title: Commune de l'établissement d'études + type: string + description: Code Insee à 5 chiffres de la commune de + l'établissement d'études de l'étudiant. + example: '29085' + etablissement_etudes: + title: Établissement d'études + description: "Code UAI et libellé de l'établissement + d'enseignement supérieur dans lequel l'étudiant est + admis. \n\nPour retrouver d'autres informations sur + l'établissement, vous pouvez utiliser l'[API \"Annuaire + de l'éducation nationale\"](https://api.gouv.fr/les-api/api-annuaire-education) + ou le site https://annuaire-education.fr.\n" + type: object + properties: + uai: + title: Code UAI + type: string + description: 'Code d''unité administrative immatriculée + (code UAI) de l''établissement où est scolarisé + l''élève. Ce code unique inscrit au répertoire + national des établissements est composé de 7 chiffres + et d''une lettre ; les trois premiers chiffres + correspondent au numéro de département de l''établissement. + + ' + pattern: "^\\d{7}\\w$" + example: 0011402U + nom: + title: Appelation officielle + type: string + description: Appelation officielle de l'établissement + associée au code UAI. + example: EGC AIN BOURG EN BRESSE EC GESTION ET COMMERCE + (01000) + required: + - admissions + additionalProperties: false + links: + type: object + meta: + type: object + required: + - data + - links + - meta + '404': + description: Étudiant non identifié + content: + application/json: + examples: + entite_non_trouvee_25003: + value: + errors: + - code: '25003' + title: Entité non trouvée + detail: Aucun étudiant n'a pu être trouvé. + source: + meta: + provider: MESRI + summary: Entité non trouvée + description: Aucun étudiant n'a pu être trouvé. + schema: + "$ref": "#/components/schemas/Error" + "/v3/mesri/statut_etudiant/ine": + get: + summary: Statut étudiant + tags: + - Statut étudiant + parameters: + - name: recipient + in: query + description: |- + "**Bénéficiaire de l’appel** + + SIRET de l’administration destinatrice des données." + example: '13002526500013' + required: true + schema: + type: string + - name: ine + in: query + description: Identifiant National Étudiant (INE). Cet identifiant est unique + à chaque étudiant sur le territoire français. Il est composé de 11 caractères, + 10 chiffres et 1 lettre, et depuis la rentrée 2018, 9 chiffres et 2 lettres. + Les étudiants peuvent retrouver leur numéro INE sur leur carte étudiant + et leur certificat de scolarité. + example: 1234567890G + schema: + type: string + pattern: "^[0-9a-zA-Z]{11}$" + required: true + security: + - jwt_bearer_token: [] + description: Admissions et inscriptions d'un étudiant aux établissements d'enseignement + supérieur. + responses: + '401': + description: Non autorisé + content: + application/json: + examples: + invalid_token_error: + value: + errors: + - code: '00101' + title: Interdit + detail: Votre token n'est pas valide ou n'est pas renseigné + source: + parameter: token + meta: {} + summary: Interdit + description: Votre token n'est pas valide ou n'est pas renseigné + expired_token_error: + value: + errors: + - code: '00103' + title: Jeton expiré + detail: Votre token est expiré. Vous devez refaire une demande + source: + parameter: token + meta: {} + summary: Jeton expiré + description: Votre token est expiré. Vous devez refaire une demande + blacklisted_token_error: + value: + errors: + - code: '00105' + title: Jeton sur liste noire + detail: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver + un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + source: + parameter: token + meta: {} + summary: Jeton sur liste noire + description: 'Votre jeton est sur liste noire, celui-ci a certainement + été divulgué sur un canal non-sécurisé. Vous pouvez trouver un + jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte' + schema: + "$ref": "#/components/schemas/Error" + '403': + description: Accès interdit + content: + application/json: + examples: + insufficient_privileges_error: + value: + errors: + - code: '00100' + title: Privilèges insuffisants + detail: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + source: + parameter: token + meta: {} + summary: Privilèges insuffisants + description: Votre token est valide mais vos privilèges sont insuffisants. + Listez vos privilèges sur /api/introspect + schema: + "$ref": "#/components/schemas/Error" + '429': + description: Trop de requêtes + content: + application/json: + examples: + too_many_requests_error: + value: + errors: + - code: '00429' + title: Trop de requêtes + detail: Vous avez effectué trop de requêtes + source: + meta: {} + summary: Trop de requêtes + description: Vous avez effectué trop de requêtes + schema: + "$ref": "#/components/schemas/Error" + '200': + description: Étudiant identifié + x-operationId: api_particulier_v3_mesri_statut_etudiant_with_ine + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + admissions: + title: Admissions de l'étudiant dans un ou plusieurs établissements + description: "Liste des admissions de l'étudiant dans un ou + plusieurs établissements d'enseignement supérieur pour l'année + en cours. \n\nChaque objet listé correspond à un établissement + dans lequel l'étudiant est au minimum admis. C'est-à-dire + que l'étudiant est au minimum pré-inscrit dans l'établissement.\n\nSi + l'étudiant est inscrit dans l'établissement (procédure complète + et règlement des droits d'inscription terminés), la clé + est_inscrit sera alors à true pour l'objet concerné.\n" + type: array + items: + type: object + properties: + date_debut: + title: Date de début de période d'études + type: string + format: date + description: Date de début de la période d'études dans + l'établissement. + example: '2022-09-01' + date_fin: + title: Date de fin de période d'études + type: string + format: date + description: Date de fin de la période d'étude dans + l'établissement. + example: '2023-08-31' + est_inscrit: + title: Statut étudiant inscrit + type: boolean + example: true + enum: + - true + - false + description: | + Indique que l'étudiant est inscrit dans l'établissement. + + Si le champ est à false, c'est que l'étudiant n'est pas inscrit, mais seulement admis dans l'établissement. C'est-à-dire que l'étudiant est pré-inscrit dans l'établissement mais que la procédure complète d'inscription et le règlement des droits d'inscription ne sont pas terminés. Les étudiants admis deviennent inscrits, une fois leurs droits d'inscription régularisés (paiement des droits, premier versement des droits ou acquittement des droits selon la situation de l'étudiant et les règles de l'établissement.). Tous les étudiants admis ne seront pas forcément de futurs étudiants inscrits dans l'établissement. + regime_formation: + title: Régime de formation + description: "Régime de formation de l'étudiant. La + liste des régimes possibles est la suivante : \n - + RF1 : formation initiale\n - RF2 : formation initiale + hors apprentissage\n - RF3 : reprise d'études non + financée sans convention\n - RF4 : contrat d'apprentissage\n + \ - RF5 : formation continue\n - RF6 : formation + continue hors contrat professionnel\n - RF7 : contrat + de professionnalisation\n" + type: object + properties: + libelle: + title: Libellé + type: string + description: 'Libellé de la formation de l''étudiant. + + ' + example: formation initiale + enum: + - formation initiale + - formation initiale hors apprentissage + - reprise d'études non financée sans convention + - contrat d'apprentissage + - formation continue + - formation continue hors contrat professionnel + - contrat de professionnalisation + code: + title: Code + type: string + description: 'Code de la formation correspondant + au régime. C''est un code technique pour exploiter + différents mécanismes indépendament du label du + régime. + + ' + example: RF1 + enum: + - RF1 + - RF2 + - RF3 + - RF4 + - RF5 + - RF6 + - RF7 + code_cog_insee_commune: + title: Commune de l'établissement d'études + type: string + description: Code Insee à 5 chiffres de la commune de + l'établissement d'études de l'étudiant. + example: '29085' + etablissement_etudes: + title: Établissement d'études + description: "Code UAI et libellé de l'établissement + d'enseignement supérieur dans lequel l'étudiant est + admis. \n\nPour retrouver d'autres informations sur + l'établissement, vous pouvez utiliser l'[API \"Annuaire + de l'éducation nationale\"](https://api.gouv.fr/les-api/api-annuaire-education) + ou le site https://annuaire-education.fr.\n" + type: object + properties: + uai: + title: Code UAI + type: string + description: 'Code d''unité administrative immatriculée + (code UAI) de l''établissement où est scolarisé + l''élève. Ce code unique inscrit au répertoire + national des établissements est composé de 7 chiffres + et d''une lettre ; les trois premiers chiffres + correspondent au numéro de département de l''établissement. + + ' + pattern: "^\\d{7}\\w$" + example: 0011402U + nom: + title: Appelation officielle + type: string + description: Appelation officielle de l'établissement + associée au code UAI. + example: EGC AIN BOURG EN BRESSE EC GESTION ET COMMERCE + (01000) + identite: + title: Données d'identité de l'étudiant + description: Données d'identité de l'étudiant corrigées et + certifiées via l'API Ines qui croise l'état civil et le + numéro INE de l'étudiant. + type: object + properties: + nom_naissance: + title: Nom de naissance + type: string + description: "Nom de naissance de l'étudiant. Il s'agit + du nom de famille tel qu'indiqué sur l'acte de naissance, + de mariage, sur le livret de famille, etc. Ce nom figure + toujours sur la pièce d'identité en premier, avant le + nom d'usage si le particulier en a un. \n\nEn cas de + changement de nom de naissance, une mention avec le + nouveau nom de famille est inscrite sur l'acte de naissance.\n" + example: Moustaki + prenom: + title: Prénom + type: string + description: Prénom de l'étudiant. + example: Georges + date_naissance: + title: Date de naissance + type: string + format: date + description: Date de naissance de l'étudiant. + example: '1992-11-29' + required: + - nom_naissance + - prenom + - date_naissance + required: + - admissions + - identite + additionalProperties: false + links: + type: object + meta: + type: object + required: + - data + - links + - meta + '404': + description: Étudiant non identifié + content: + application/json: + examples: + entite_non_trouvee_25003: + value: + errors: + - code: '25003' + title: Entité non trouvée + detail: Aucun étudiant n'a pu être trouvé avec les critères + de recherche fournis. + source: + meta: + provider: MESRI + summary: Entité non trouvée + description: Aucun étudiant n'a pu être trouvé avec les critères + de recherche fournis. + schema: + "$ref": "#/components/schemas/Error" + '502': + description: Erreur du fournisseur + content: + application/json: + examples: + provider_unknown_error: + value: + errors: + - code: '25999' + title: Erreur inconnue du fournisseur de données + detail: La réponse retournée par le fournisseur de données est + invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + source: + meta: + provider: MESRI + summary: Erreur inconnue du fournisseur de données + description: La réponse retournée par le fournisseur de données + est invalide et inconnue de notre service. L'équipe technique + a été notifiée de cette erreur pour investigation. + schema: + "$ref": "#/components/schemas/Error" + '504': + description: Erreur d'intermédiaire + content: + application/json: + examples: + timeout_error: + value: + errors: + - code: '25002' + title: Intermédiaire hors-délai + detail: Temps d’attente d’une réponse du fournisseur de données + écoulé. + source: + meta: + provider: MESRI + summary: Intermédiaire hors-délai + description: Temps d’attente d’une réponse du fournisseur de données + écoulé. + provider_unavailable_error: + value: + errors: + - code: '25001' + title: Service non disponible + detail: Service du fournisseur de données temporairement indisponible + ou en maintenance. + source: + meta: + provider: MESRI + summary: Service non disponible + description: Service du fournisseur de données temporairement indisponible + ou en maintenance. + network_error: + value: + errors: + - code: '00501' + title: Erreur réseau + detail: Problème de connexion au serveur distant. L'erreur peut + venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + source: + meta: + retry_in: 10 + summary: Erreur réseau + description: Problème de connexion au serveur distant. L'erreur + peut venir soit du fournisseur, soit de API Entreprise. Il s'agit + souvent d'une erreur temporaire. + dns_resolution_error: + value: + errors: + - code: '25004' + title: Erreur de résolution DNS + detail: Problème de résolution DNS de l'adresse du serveur + source: + meta: + provider: MESRI + summary: Erreur de résolution DNS + description: Problème de résolution DNS de l'adresse du serveur + schema: + "$ref": "#/components/schemas/Error" +servers: +- url: https://particulier.api.gouv.fr + description: Environnement de production +- url: https://staging.particulier.api.gouv.fr + description: Environnement de staging +components: + schemas: + Error: + type: object + properties: + errors: + type: array + items: + type: object + properties: + title: + type: string + detail: + type: string + code: + type: string + required: + - title + - detail + - code + required: + - errors + securitySchemes: + jwt_bearer_token: + type: http + description: |- + Votre jeton d'authentification doit être placé dans le header 'Authorization: Bearer VOTRE_JWT', sa validité est de 18 mois. Dans le cas où vous utilisez une API FranceConnectée, vous devez utiliser le jeton FranceConnect à la place du jeton d'authentification. + + Exemple cURL : + + curl -X GET \ + -H "Authorization: Bearer $token" \ + --url "https://entreprise.api.gouv.fr/v3/..." + name: Authorization + in: header + scheme: bearer + bearerFormat: JWT diff --git a/config/api-particulier-openapi.yml b/config/api-particulier-openapi.yml index 84855eacd..0a60c12e2 100644 --- a/config/api-particulier-openapi.yml +++ b/config/api-particulier-openapi.yml @@ -57,11 +57,17 @@ tags: [] paths: "/api/v2/allocation-adulte-handicape": get: - summary: Allocation Adulte Handicapé + summary: Statut allocation adulte handicapé (AAH) tags: - - AAH - - Prochainement + - Prestations sociales parameters: + - name: Cache-Control + in: header + description: Si cette valeur est fixée à "no-cache", le système de cache est + alors ignoré et la donnée est directement récupérée depuis le fournisseur + de données. + schema: + type: string - name: X-Api-Key in: header schema: @@ -76,6 +82,7 @@ paths: - name: nomNaissance in: query description: Nom de naissance. Ne pas renseigner si présence de jeton FranceConnect. + Le champ est obligatoire pour les appels non FranceConnecté example: JEAN required: false schema: @@ -129,7 +136,7 @@ paths: 5 chiffres. Ne pas remplir si la personne est née à l'étranger ou si présence de jeton FranceConnect. En l'absence de jeton FranceConnect et du triplet (nomCommuneNaissance, anneeDateDeNaissance, codeInseeDepartementNaissance), - le champs est obligatoire si la personne est née en France + le champ est obligatoire si la personne est née en France required: false - name: codePaysLieuDeNaissance in: query @@ -152,6 +159,27 @@ paths: de jeton FranceConnect. example: M required: false + - name: nomCommuneNaissance + in: query + schema: + type: string + minLength: 1 + example: Gennevilliers + description: Nom de la commune de naissance. En l'absence de jeton FranceConnect + et du codeInseeLieuDeNaissance, ce paramètre est obligatoire si la personne + est née en France + required: false + - name: codeInseeDepartementNaissance + in: query + schema: + type: string + minLength: 2 + maxLength: 3 + example: '92' + description: Code INSEE du département de naissance. En l'absence de jeton + FranceConnect et du codeInseeLieuDeNaissance, ce paramètre est obligatoire + si la personne est née en France + required: false - name: recipient in: query description: |- @@ -166,13 +194,30 @@ paths: security: - franceConnectToken: [] apiKey: [] - description: Savoir si un particulier est bénéficiaire de l'Allocation Adulte - Handicapé (AAH). Retourne également des informations sur les dates d'ouverture - des droits. L'API peut être appellée avec les données identité pivot ou avec - un jeton FranceConnect. + description: "Statut bénéficiaire de l'allocation adulte handicapé (AAH). \n\n + Retourne également des informations sur les dates d'ouverture des droits. + \n L'API peut être appellée avec les données identité pivot ou avec un jeton + FranceConnect." responses: '200': description: Particulier trouvé + headers: + X-Response-Cached: + schema: + type: boolean + example: true + enum: + - true + - false + default: false + description: Indique si la réponse a été caché. + X-Cache-Expires-in: + schema: + type: number + nullable: true + example: 9001 + description: Secondes avant que le cache n'expire. Si le cache est vide, + ce header est vide (mais présent). La durée du cache est de 1 heure. x-operationId: api_particulier_v2_cnav_allocation_adulte_handicape content: application/json: @@ -180,7 +225,7 @@ paths: type: object properties: status: - title: Statut bénéficiaire de l'Allocation Adulte Handicapé (AAH) + title: Statut bénéficiaire de l'allocation adulte handicapé (AAH) type: string description: Indique si le particulier est bénéficiaire de la complémentaire de santé solidaire au moment de l'appel. @@ -191,9 +236,9 @@ paths: title: Date d'ouverture du droit à l'AAH type: string nullable: true - description: "Date de début de droit à l'AAH si le particulier - est bénéficiaire. \n Ce champs est null dans le cas où le particulier - n'est pas bénéficiaire de l'AAH." + description: | + "Date de début de droit à l'AAH si le particulier est bénéficiaire. + Ce champs est null dans le cas où le particulier n'est pas bénéficiaire de l'AAH." example: '1992-11-29' '400': description: Mauvais paramètres d'appels @@ -265,11 +310,17 @@ paths: "$ref": "#/components/schemas/Error" "/api/v2/allocation-soutien-familial": get: - summary: Allocation de Soutien Familial + summary: Statut allocation de soutien familial (ASF) tags: - - ASF - - Prochainement + - Prestations sociales parameters: + - name: Cache-Control + in: header + description: Si cette valeur est fixée à "no-cache", le système de cache est + alors ignoré et la donnée est directement récupérée depuis le fournisseur + de données. + schema: + type: string - name: X-Api-Key in: header schema: @@ -295,6 +346,7 @@ paths: - name: nomNaissance in: query description: Nom de naissance. Ne pas renseigner si présence de jeton FranceConnect. + Le champ est obligatoire pour les appels non FranceConnecté example: JEAN required: false schema: @@ -348,7 +400,7 @@ paths: 5 chiffres. Ne pas remplir si la personne est née à l'étranger ou si présence de jeton FranceConnect. En l'absence de jeton FranceConnect et du triplet (nomCommuneNaissance, anneeDateDeNaissance, codeInseeDepartementNaissance), - le champs est obligatoire si la personne est née en France + le champ est obligatoire si la personne est née en France required: false - name: codePaysLieuDeNaissance in: query @@ -371,16 +423,54 @@ paths: de jeton FranceConnect. example: M required: false + - name: nomCommuneNaissance + in: query + schema: + type: string + minLength: 1 + example: Gennevilliers + description: Nom de la commune de naissance. En l'absence de jeton FranceConnect + et du codeInseeLieuDeNaissance, ce paramètre est obligatoire si la personne + est née en France + required: false + - name: codeInseeDepartementNaissance + in: query + schema: + type: string + minLength: 2 + maxLength: 3 + example: '92' + description: Code INSEE du département de naissance. En l'absence de jeton + FranceConnect et du codeInseeLieuDeNaissance, ce paramètre est obligatoire + si la personne est née en France + required: false security: - franceConnectToken: [] apiKey: [] - description: Savoir si un particulier est bénéficiaire de l'Allocation de Soutien - Familial (ASF). Retourne également des informations sur les dates d'ouverture + description: Savoir si un particulier est bénéficiaire de l'allocation de soutien + familial (ASF). Retourne également des informations sur les dates d'ouverture et de fermeture des droits. L'API peut être appellée avec les données identité pivot ou avec un jeton FranceConnect. responses: '200': description: Dossier trouvé + headers: + X-Response-Cached: + schema: + type: boolean + example: true + enum: + - true + - false + default: false + description: Indique si la réponse a été caché. + X-Cache-Expires-in: + schema: + type: number + nullable: true + example: 9001 + description: Secondes avant que le cache n'expire. Si le cache est vide, + ce header est vide (mais présent). La durée du cache est de 1 heure. x-operationId: api_particulier_v2_cnav_allocation_soutien_familial content: application/json: @@ -388,11 +478,11 @@ paths: type: object properties: status: - title: Statut bénéficiaire de l'Allocation de Soutien Familial + title: Statut bénéficiaire de l'allocation de soution familial (ASF) type: string - description: Indique si le particulier est bénéficiaire de l'Allocation - de Soutien Familial au moment de l'appel. + description: Indique si le particulier est bénéficiaire de l'allocation + de soution familial au moment de l'appel. enum: - beneficiaire - non_beneficiaire @@ -401,19 +491,15 @@ paths: type: string nullable: true description: "Date de début de droit à l'ASF si le particulier - est bénéficiaire. \n Ce champs est null dans le cas où le particulier + est bénéficiaire. \n Ce champ est null dans le cas où le particulier n'est pas bénéficiaire de l'ASF." example: '1992-11-29' dateFin: title: Date de fermeture du droit à l'ASF type: string nullable: true - description: "Date de fin de droit à l'Allocation de Soutien Familial - du particulier bénéficiaire. \n Ce champs est calculé en ajoutant - 12 mois à la date de début de droit à l'ASF. \n Ce champs sera - null dans le cas où le particulier n'est pas bénéficiaire de - l'ASF." - example: '1993-11-29' + description: Ce champs ne délivrant pas l'information souhaitée à la base il est toujours à null désormais + example: null '400': description: Mauvais paramètres d'appels content: @@ -484,10 +570,17 @@ paths: "$ref": "#/components/schemas/Error" "/api/v2/complementaire-sante-solidaire": get: - summary: Complémentaire santé solidaire + summary: Statut complémentaire santé solidaire (C2S) tags: - - Complementaire Sante Solidaire + - Prestations sociales parameters: + - name: Cache-Control + in: header + description: Si cette valeur est fixée à "no-cache", le système de cache est + alors ignoré et la donnée est directement récupérée depuis le fournisseur + de données. + schema: + type: string - name: X-Api-Key in: header schema: @@ -513,6 +606,7 @@ paths: - name: nomNaissance in: query description: Nom de naissance. Ne pas renseigner si présence de jeton FranceConnect. + Le champ est obligatoire pour les appels non FranceConnecté example: JEAN required: false schema: @@ -566,7 +660,7 @@ paths: 5 chiffres. Ne pas remplir si la personne est née à l'étranger ou si présence de jeton FranceConnect. En l'absence de jeton FranceConnect et du triplet (nomCommuneNaissance, anneeDateDeNaissance, codeInseeDepartementNaissance), - le champs est obligatoire si la personne est née en France + le champ est obligatoire si la personne est née en France required: false - name: codePaysLieuDeNaissance in: query @@ -613,217 +707,41 @@ paths: security: - franceConnectToken: [] apiKey: [] - description: "Savoir si un particulier est bénéficiaire de la complémentaire - santé solidaire (C2S). \n\n Pour de plus amples informations sur cette api - et y avoir accès en avant première, veuillez contacter l'équipe API Particulier. - \n **Données disponibles en bac à sable :** [liste](https://github.com/etalab/siade_staging_data/blob/develop/payloads/complementaire_sante_solidaire) + description: "Statut bénéficiaire de la complémentaire santé solidaire (C2S). + \n\n Retourne également des informations sur les dates d'ouverture des droits. + \n Pour plus d'informations sur cette API et obtenir un accès en avant-première, + veuillez contacter l'équipe API Particulier. \n **Données disponibles en bac + à sable :** [liste](https://github.com/etalab/siade_staging_data/blob/develop/payloads/complementaire_sante_solidaire) \n L'API peut être appellée avec les données identité pivot ou avec un jeton - FranceConnect. " + FranceConnect." responses: '200': - description: Quotient Familial trouvée + description: Complementaire Santé Solidaire trouvée + headers: + X-Response-Cached: + schema: + type: boolean + example: true + enum: + - true + - false + default: false + description: Indique si la réponse a été caché. + X-Cache-Expires-in: + schema: + type: number + nullable: true + example: 9001 + description: Secondes avant que le cache n'expire. Si le cache est vide, + ce header est vide (mais présent). La durée du cache est de 1 heure. x-operationId: api_particulier_v2_cnav_complementaire_sante_solidaire content: application/json: schema: type: object properties: - allocataires: - title: Informations sur les parents composant la famille - type: array - minItems: 1 - items: - type: object - properties: - nomNaissance: - title: Nom - type: string - description: Nom de naissance de l'allocataire - example: JACQUES - nomUsuel: - title: Nom d'usage - type: string - description: Nom d'usage de l'allocataire - example: JACQUES - nullable: true - prenoms: - title: Prénoms - type: string - description: Prénoms de l'allocataire - example: JEAN-PIERRE THOMAS - anneeDateDeNaissance: - title: Année de naissance - type: string - example: '2000' - description: Année de la date de naissance de l'allocataire. - Peut-être vide si inconnue. - nullable: true - moisDateDeNaissance: - title: Mois de naissance - type: string - example: '01' - description: Mois de la date de naissance de l'allocataire. - Peut-être vide si inconnue. - nullable: true - jourDateDeNaissance: - title: Jour de naissance - type: string - example: '31' - description: Jour de la date de naissance de l'allocataire. - Peut-être vide si inconnue. - nullable: true - sexe: - title: Sexe - type: string - description: Sexe de l'allocataire - example: M - enum: - - F - - M - enfants: - type: array - title: Informations sur les enfants composant la famille - items: - type: object - properties: - nomNaissance: - title: Nom de naissance - type: string - description: Nom de naissance de l'enfant - example: JACQUES - nomUsuel: - title: Nom d'usage - type: string - description: Nom d'usage de l'enfant - example: JACQUES - nullable: true - prenoms: - title: Prénoms - type: string - description: Prénoms de l'enfant - example: JEAN-PIERRE THOMAS - anneeDateDeNaissance: - title: Année de naissance - type: string - example: '2000' - description: Année de la date de naissance de l'enfant. - Peut-être vide si inconnue. - nullable: true - moisDateDeNaissance: - title: Mois de naissance - type: string - example: '01' - description: Mois de la date de naissance de l'enfant. Peut-être - vide si inconnue. - nullable: true - jourDateDeNaissance: - title: Jour de naissance - type: string - example: '31' - description: Jour de la date de naissance de l'enfant. Peut-être - vide si inconnue. - nullable: true - sexe: - title: Sexe - type: string - description: Sexe de l'enfant - example: M - enum: - - F - - M - adresse: - title: Adresse de la famille - type: object - description: Adresse au format de la poste - properties: - identite: - title: Identité du destinataire - type: string - example: Monsieur JEAN JACQUES - description: 'Identité du destinataire : Civilité, titre ou - qualité + nom et prénom' - complementInformation: - title: Complément d'information du destinataire ou point de - remise - description: Complément d'information du destinataire ou point - de remise. - type: string - nullable: true - example: - complementInformationGeographique: - title: Complément d'information du point géographique - type: string - nullable: true - example: - description: Complément d'information du point géographique. - numeroLibelleVoie: - title: Voie - type: string - description: Numéro et libellé de la voie - example: 1 RUE DE LA GARE - nullable: true - lieuDit: - title: Lieu-dit - type: string - nullable: true - example: - description: 'Lieu-dit ou service particulier de distribution - : poste restante, boîte postale' - codePostalVille: - title: Code postal - type: string - description: Code postale et localité de destination - example: '75002' - pays: - title: Pays - type: string - description: Pays - example: FRANCE - required: - - identite - - complementInformation - - complementInformationGeographique - - numeroLibelleVoie - - lieuDit - - codePostalVille - - pays - regime: - title: Régime de l'allocataire - type: string - description: Précise le régime de l'allocataire (CNAF ou MSA) - example: MSA - enum: - - CNAF - - MSA - quotientFamilial: - title: Quotient familial CAF ou MSA - type: integer - description: Valeur du quotient familial calculé par la CAF ou - la MSA - example: 1045 - annee: - title: Année du quotient familial - type: integer - description: Année de calcul du quotient familial - example: 2023 - mois: - title: Mois du quotient familial - type: integer - description: Mois de calcul du quotient familial - example: 6 - annee_calcul: - title: Année du calcul du quotient familial - type: integer - description: Année à laquelle le quotient familial a été calculé - example: 2023 - mois_calcul: - title: Mois du calcul du quotient familial - type: integer - description: Mois auquel le quotient familial a été calculé - example: 3 status: - title: Statut bénéficiaire de la complémentaire santé solidaire - (C2S) + title: Statut bénéficiaire de la C2S type: string description: "Indique si le particulier est bénéficiaire de la complémentaire de santé solidaire au moment de l'appel. Cet @@ -844,7 +762,7 @@ paths: type: string nullable: true description: "Date de début de droit à la complémentaire santé - solidaire (C2S) si le particulier est bénéficiaire. \n Ce champs + solidaire (C2S) si le particulier est bénéficiaire. \n Ce champ est null dans le cas où le particulier n'est pas bénéficiaire de la C2S." example: '1992-11-29' @@ -852,12 +770,8 @@ paths: title: Date de fermeture du droit à la C2S type: string nullable: true - description: "Date de fin de droit à la complémentaire santé solidaire - (C2S) du particulier bénéficiaire. \n Ce champs est calculé - en ajoutant 12 mois à la date de début de droit à la C2S. \n - Ce champs sera null dans le cas où le particulier n'est pas - bénéficiaire de la C2S." - example: '1993-11-29' + description: Ce champs ne délivrant pas l'information souhaitée à la base il est toujours à null désormais + example: null '400': description: Mauvais paramètres d'appels content: @@ -929,11 +843,17 @@ paths: "$ref": "#/components/schemas/Error" "/api/v2/prime-activite": get: - summary: Prime d'activité + summary: Statut prime d'activité tags: - - Prime d'activité - - Prochainement + - Prestations sociales parameters: + - name: Cache-Control + in: header + description: Si cette valeur est fixée à "no-cache", le système de cache est + alors ignoré et la donnée est directement récupérée depuis le fournisseur + de données. + schema: + type: string - name: X-Api-Key in: header schema: @@ -959,6 +879,7 @@ paths: - name: nomNaissance in: query description: Nom de naissance. Ne pas renseigner si présence de jeton FranceConnect. + Le champ est obligatoire pour les appels non FranceConnecté example: JEAN required: false schema: @@ -1012,7 +933,7 @@ paths: 5 chiffres. Ne pas remplir si la personne est née à l'étranger ou si présence de jeton FranceConnect. En l'absence de jeton FranceConnect et du triplet (nomCommuneNaissance, anneeDateDeNaissance, codeInseeDepartementNaissance), - le champs est obligatoire si la personne est née en France + le champ est obligatoire si la personne est née en France required: false - name: codePaysLieuDeNaissance in: query @@ -1035,16 +956,54 @@ paths: de jeton FranceConnect. example: M required: false + - name: nomCommuneNaissance + in: query + schema: + type: string + minLength: 1 + example: Gennevilliers + description: Nom de la commune de naissance. En l'absence de jeton FranceConnect + et du codeInseeLieuDeNaissance, ce paramètre est obligatoire si la personne + est née en France + required: false + - name: codeInseeDepartementNaissance + in: query + schema: + type: string + minLength: 2 + maxLength: 3 + example: '92' + description: Code INSEE du département de naissance. En l'absence de jeton + FranceConnect et du codeInseeLieuDeNaissance, ce paramètre est obligatoire + si la personne est née en France + required: false security: - franceConnectToken: [] apiKey: [] - description: Savoir si un particulier est bénéficiaire de la Prime d'activité - (PA). Précise également si la PA est majorée ainsi que les dates d'ouverture - et de fermeture des droits. L'API peut être appellée avec les données identité - pivot ou avec un jeton FranceConnect. + description: "Statut bénéficiaire de la prime d'activité, majorée ou non. \n\n + Retourne également des informations sur les dates d'ouverture des droits. + \n L'API peut être appellée avec les données identité pivot ou avec un jeton + FranceConnect." responses: '200': description: Dossier trouvé + headers: + X-Response-Cached: + schema: + type: boolean + example: true + enum: + - true + - false + default: false + description: Indique si la réponse a été caché. + X-Cache-Expires-in: + schema: + type: number + nullable: true + example: 9001 + description: Secondes avant que le cache n'expire. Si le cache est vide, + ce header est vide (mais présent). La durée du cache est de 1 heure. x-operationId: api_particulier_v2_cnav_prime_activite content: application/json: @@ -1052,7 +1011,7 @@ paths: type: object properties: status: - title: Statut bénéficiaire de la Prime d'activité + title: Statut bénéficiaire de la prime d'activité type: string description: Indique si le particulier est bénéficiaire de la prime d'activité au moment de l'appel. @@ -1060,33 +1019,29 @@ paths: - beneficiaire - non_beneficiaire majoration: - title: Majoration de la prime d'activité + title: Statut bénéficiaire de la majoration de la prime d'activité type: boolean nullable: true description: Indique si le particulier est bénéficiaire de la - prime d'activité majorée au moment de l'appel. Nécessite un - scope spécifique pour être envoyé. Sera null si le particulier - n'est pas bénéficiaire de la prime d'activité. + prime d'activité majorée au moment de l'appel. Ce champ est + renvoyé si les droits du jeton (obtenus par habilitation) le + permettent. Ce champ sera null si le particulier n'est pas bénéficiaire + de la prime d'activité. example: false dateDebut: title: Date d'ouverture du droit à la prime d'activité type: string nullable: true description: "Date de début de droit à la prime d'activité si - le particulier est bénéficiaire. \n Ce champs est null dans - le cas où le particulier n'est pas bénéficiaire de la prime - d'activité." + le particulier est bénéficiaire. \n Ce champ est null dans le + cas où le particulier n'est pas bénéficiaire de la prime d'activité." example: '1992-11-20' dateFin: title: Date de fermeture du droit à la prime d'activité type: string nullable: true - description: "Date de fin de droit à la prime d'activité du particulier - bénéficiaire. \n Ce champs est calculé en ajoutant 3 mois à - la date de début de droit de la prime d'activité. \n Ce champs - sera null dans le cas où le particulier n'est pas bénéficiaire - de la prime d'activité." - example: '1993-02-20' + description: Ce champs ne délivrant pas l'information souhaitée à la base il est toujours à null désormais + example: null '400': description: Mauvais paramètres d'appels content: @@ -1161,6 +1116,13 @@ paths: tags: - Quotient familial parameters: + - name: Cache-Control + in: header + description: Si cette valeur est fixée à "no-cache", le système de cache est + alors ignoré et la donnée est directement récupérée depuis le fournisseur + de données. + schema: + type: string - name: X-Api-Key in: header schema: @@ -1186,6 +1148,7 @@ paths: - name: nomNaissance in: query description: Nom de naissance. Ne pas renseigner si présence de jeton FranceConnect. + Le champ est obligatoire pour les appels non FranceConnecté example: JEAN required: false schema: @@ -1239,7 +1202,7 @@ paths: 5 chiffres. Ne pas remplir si la personne est née à l'étranger ou si présence de jeton FranceConnect. En l'absence de jeton FranceConnect et du triplet (nomCommuneNaissance, anneeDateDeNaissance, codeInseeDepartementNaissance), - le champs est obligatoire si la personne est née en France + le champ est obligatoire si la personne est née en France required: false - name: codePaysLieuDeNaissance in: query @@ -1286,15 +1249,16 @@ paths: - name: annee in: query description: Année du quotient familial recherché. Si l'année n'est pas renseignée, - le dernier QF est transmis. Remonte au maximum à 2 ans. + l'année utilisée par défaut est celle en cours. L'API permet d'accéder à + un historique de maximum 2 ans. example: 2023 required: false schema: type: integer - name: mois in: query - description: Mois pour le quotient, si non renseigné renvoie le dernier QF - calculé + description: Mois du quotient familial recherché. Si le mois n'est pas renseigné, + le mois utilisé par défaut est celui en cours. example: 12 required: false schema: @@ -1303,14 +1267,31 @@ paths: - franceConnectToken: [] apiKey: [] description: "Quotient familial et composition de la famille d'un allocataire - du régime agricole (régime général à venir). \n Pour de plus amples informations - sur cette api et y avoir accès en avant première, veuillez contacter l'équipe + du régime agricole (régime général à venir). \n Pour plus d'informations sur + cette API et obtenir un accès en avant-première, veuillez contacter l'équipe API Particulier. \n **Données disponibles en bac à sable :** [liste](https://github.com/etalab/siade_staging_data/blob/develop/payloads/api_particulier_v2_cnav_quotient_familial_v2) \n L'API peut être appellée avec les données identité pivot ou avec un jeton FranceConnect." responses: '200': description: Quotient Familial trouvé + headers: + X-Response-Cached: + schema: + type: boolean + example: true + enum: + - true + - false + default: false + description: Indique si la réponse a été caché. + X-Cache-Expires-in: + schema: + type: number + nullable: true + example: 9001 + description: Secondes avant que le cache n'expire. Si le cache est vide, + ce header est vide (mais présent). La durée du cache est de 24 heure. content: application/json: examples: @@ -1395,14 +1376,14 @@ paths: type: string example: '01' description: Mois de la date de naissance de l'allocataire. - Peut-être vide si inconnue. + Peut-être vide si inconnu. nullable: true jourDateDeNaissance: title: Jour de naissance type: string example: '31' description: Jour de la date de naissance de l'allocataire. - Peut-être vide si inconnue. + Peut-être vide si inconnu. nullable: true sexe: title: Sexe @@ -1446,14 +1427,14 @@ paths: type: string example: '01' description: Mois de la date de naissance de l'enfant. Peut-être - vide si inconnue. + vide si inconnu. nullable: true jourDateDeNaissance: title: Jour de naissance type: string example: '31' description: Jour de la date de naissance de l'enfant. Peut-être - vide si inconnue. + vide si inconnu. nullable: true sexe: title: Sexe @@ -1477,8 +1458,6 @@ paths: complementInformation: title: Complément d'information du destinataire ou point de remise - description: Complément d'information du destinataire ou point - de remise. type: string nullable: true example: @@ -1504,7 +1483,7 @@ paths: codePostalVille: title: Code postal type: string - description: Code postale et localité de destination + description: Code postal et localité de destination example: '75002' pays: title: Pays @@ -1519,14 +1498,6 @@ paths: - lieuDit - codePostalVille - pays - regime: - title: Régime de l'allocataire - type: string - description: Précise le régime de l'allocataire (CNAF ou MSA) - example: MSA - enum: - - CNAF - - MSA quotientFamilial: title: Quotient familial CAF ou MSA type: integer @@ -1534,25 +1505,30 @@ paths: la MSA example: 1045 annee: - title: Année du quotient familial + title: Année effective du QF type: integer - description: Année de calcul du quotient familial + description: "Année effective du quotient familial appelé. \n\n + - Si aucune année et aucun mois n'ont été renseignés en paramètres + d'appel, le quotient familial retourné sera celui du mois de + l'année en cours. - Si aucune année, ni aucun mois sont renseignés, + l'appel est effectué par défaut avec l'année et le mois en cours. + - Si aucune année n'a été renseignée, et que le mois est renseigné, + le quotient familial retourné sera celui du mois spécifié pour + l'année en cours. En revanche, si la date finalement composée + avec cette règle s'avère dans le futur (mois postérieur au moins + en cours), l'API renvoie un erreur 400. " example: 2023 mois: - title: Mois du quotient familial + title: Mois effectif du QF type: integer - description: Mois de calcul du quotient familial + description: "Mois effectif du quotient familial. \n\n - Si aucun + mois n'est renseigné, le mois en cours est utilisé par défaut. + - Si le mois renseigné est postérieur au mois en cours, et qu'il + compose une date dans le futur avec l'année appelée, l'API renvoie + une erreur 400. \n - Si aucun mois n'a été renseigné mais que + l'année a été spécifiée en paramètres d'appel, le quotient familial + retourné sera celui du mois en cours pour l'année spécifiée." example: 6 - annee_calcul: - title: Année du calcul du quotient familial - type: integer - description: Année à laquelle le quotient familial a été calculé - example: 2023 - mois_calcul: - title: Mois du calcul du quotient familial - type: integer - description: Mois auquel le quotient familial a été calculé - example: 3 x-operationId: api_particulier_v2_cnav_quotient_familial_v2 '400': description: Mauvais paramètres d'appels @@ -1562,8 +1538,10 @@ paths: Mauvais paramètres d'appels: value: error: bad_request - reason: Le sexe n'est pas correctement formaté (m ou f) - message: Le sexe n'est pas correctement formaté (m ou f) + reason: L'année demandée n'est pas correctement formatée ou est + dans le futur. + message: L'année demandée n'est pas correctement formatée ou est + dans le futur. schema: "$ref": "#/components/schemas/Error" '404': @@ -1585,13 +1563,13 @@ paths: MSA. message: Le dossier allocataire n'a pas été trouvé auprès de la MSA. - Dossier non trouvé CNAV: + Dossier non trouvé CNAF: value: error: not_found reason: Le dossier allocataire n'a pas été trouvé auprès de la - CNAV. + CNAF. message: Le dossier allocataire n'a pas été trouvé auprès de la - CNAV. + CNAF. schema: "$ref": "#/components/schemas/Error" '503': @@ -1601,7 +1579,7 @@ paths: examples: Erreur du fournisseur: value: - error: data_provider_error + error: provider_unknown_error reason: La réponse retournée par le fournisseur de données est invalide et inconnue de notre service. L'équipe technique a été notifiée de cette erreur pour investigation. @@ -1643,11 +1621,17 @@ paths: "$ref": "#/components/schemas/Error" "/api/v2/revenu-solidarite-active": get: - summary: Revenu de solidarité active + summary: Statut revenu de solidarité active (RSA) tags: - - RSA - - Prochainement + - Prestations sociales parameters: + - name: Cache-Control + in: header + description: Si cette valeur est fixée à "no-cache", le système de cache est + alors ignoré et la donnée est directement récupérée depuis le fournisseur + de données. + schema: + type: string - name: X-Api-Key in: header schema: @@ -1673,6 +1657,7 @@ paths: - name: nomNaissance in: query description: Nom de naissance. Ne pas renseigner si présence de jeton FranceConnect. + Le champ est obligatoire pour les appels non FranceConnecté example: JEAN required: false schema: @@ -1726,7 +1711,7 @@ paths: 5 chiffres. Ne pas remplir si la personne est née à l'étranger ou si présence de jeton FranceConnect. En l'absence de jeton FranceConnect et du triplet (nomCommuneNaissance, anneeDateDeNaissance, codeInseeDepartementNaissance), - le champs est obligatoire si la personne est née en France + le champ est obligatoire si la personne est née en France required: false - name: codePaysLieuDeNaissance in: query @@ -1749,16 +1734,54 @@ paths: de jeton FranceConnect. example: M required: false + - name: nomCommuneNaissance + in: query + schema: + type: string + minLength: 1 + example: Gennevilliers + description: Nom de la commune de naissance. En l'absence de jeton FranceConnect + et du codeInseeLieuDeNaissance, ce paramètre est obligatoire si la personne + est née en France + required: false + - name: codeInseeDepartementNaissance + in: query + schema: + type: string + minLength: 2 + maxLength: 3 + example: '92' + description: Code INSEE du département de naissance. En l'absence de jeton + FranceConnect et du codeInseeLieuDeNaissance, ce paramètre est obligatoire + si la personne est née en France + required: false security: - franceConnectToken: [] apiKey: [] - description: Savoir si un particulier est bénéficiaire du Revenu de solidarité - active (RSA) et si le montant du RSA est majoré ou non. Retourne également - des informations sur les dates d'ouverture des droits. L'API peut être appellée - avec les données identité pivot ou avec un jeton FranceConnect. + description: "Statut bénéficiaire du revenu de solidarité active (RSA), majoré + ou non. \n\n Retourne également des informations sur les dates d'ouverture + des droits. \n L'API peut être appellée avec les données identité pivot ou + avec un jeton FranceConnect." responses: '200': description: Dossier trouvé + headers: + X-Response-Cached: + schema: + type: boolean + example: true + enum: + - true + - false + default: false + description: Indique si la réponse a été caché. + X-Cache-Expires-in: + schema: + type: number + nullable: true + example: 9001 + description: Secondes avant que le cache n'expire. Si le cache est vide, + ce header est vide (mais présent). La durée du cache est de 1 heure. x-operationId: api_particulier_v2_cnav_revenu_solidarite_active content: application/json: @@ -1766,15 +1789,15 @@ paths: type: object properties: status: - title: Statut bénéficiaire du Revenu de solidarité active (RSA) + title: Statut bénéficiaire du revenu de solidarité active (RSA) type: string - description: Indique si le particulier est bénéficiaire du Revenu + description: Indique si le particulier est bénéficiaire du revenu de solidarité active au moment de l'appel. enum: - beneficiaire - non_beneficiaire majoration: - title: Majoration du RSA + title: Statut bénéficiaire de la majoration du RSA type: boolean nullable: true description: Indique si le particulier est bénéficiaire du RSA @@ -1787,19 +1810,15 @@ paths: type: string nullable: true description: "Date de début de droit au RSA si le particulier - est bénéficiaire. \n Ce champs est null dans le cas où le particulier + est bénéficiaire. \n Ce champ est null dans le cas où le particulier n'est pas bénéficiaire du RSA." example: '1992-11-29' dateFin: - title: Date de fermeture du droit au Revenue de solidarité active + title: Date de fermeture du droit au revenu de solidarité active type: string nullable: true - description: "Date de fin de droit au Revenue de solidarité active - du particulier bénéficiaire. \n Ce champs est calculé en ajoutant - 3 mois à la date de début de droit du RSA. \n Ce champs sera - null dans le cas où le particulier n'est pas bénéficiaire du - RSA." - example: '1993-02-20' + description: Ce champs ne délivrant pas l'information souhaitée à la base il est toujours à null désormais + example: null '400': description: Mauvais paramètres d'appels content: @@ -1872,7 +1891,7 @@ paths: get: summary: Statut élève scolarisé et boursier tags: - - Scolarité étudiant + - Éducation et études parameters: - name: X-Api-Key in: header @@ -2009,8 +2028,11 @@ paths: Indique si l'élève est boursier dans l'établissement. Les bourses concernent uniquement les élèves des collèges et lycées. ⚠️ Si le statut boursier est à "false" avant mi-octobre, cela ne signifie pas forcément que l'élève n'est pas boursier. Il peut s'agir d'un faux négatif lié à une absence de l'information en base. Pour en savoir plus consulter la fiche métier : https://particulier.api.gouv.fr/catalogue/education_nationale/statut_eleve_scolarise#faq_entry_answer_1_api_particulier_endpoint_education_nationale_statut_eleve_scolarise. + + Ce champs prend la valeur null lorsque l'on ne sait pas si l'élève est boursier ou non type: boolean example: true + nullable: true niveau_bourse: description: | Indique l'échelon de la bourse de l'élève. Est à "null" quand "est_boursier" est "false". Les bourses concernent uniquement les élèves des collèges et lycées. @@ -2020,7 +2042,7 @@ paths: example: 1 nullable: true enum: - - + - null - 1 - 2 - 3 @@ -2114,7 +2136,7 @@ paths: get: summary: Paiements versés par France Travail tags: - - Paiements France Travail + - Demandeurs d'emploi parameters: - name: X-Api-Key in: header @@ -2270,6 +2292,13 @@ paths: **Données disponibles en bac à sable :** [liste](https://github.com/etalab/siade_staging_data/blob/develop/payloads/api_particulier_v2_cnaf_quotient_familial) parameters: + - name: Cache-Control + in: header + description: Si cette valeur est fixée à "no-cache", le système de cache est + alors ignoré et la donnée est directement récupérée depuis le fournisseur + de données. + schema: + type: string - name: numeroAllocataire in: query description: Numéro d'allocataire. Numéro de 1 à 7 chiffres. Le numéro d'allocataire @@ -2305,6 +2334,23 @@ paths: '200': x-operationId: api_particulier_v2_cnaf_quotient_familial description: Foyer tel qu'il est déclaré à la CAF + headers: + X-Response-Cached: + schema: + type: boolean + example: true + enum: + - true + - false + default: false + description: Indique si la réponse a été caché. + X-Cache-Expires-in: + schema: + type: number + nullable: true + example: 9001 + description: Secondes avant que le cache n'expire. Si le cache est vide, + ce header est vide (mais présent). La durée du cache est de 1 heure. content: application/json: schema: @@ -2519,7 +2565,7 @@ paths: schema: type: string tags: - - Situation France Travail + - Demandeurs d'emploi responses: '200': x-operationId: api_particulier_v2_pole_emploi_statut @@ -2631,7 +2677,7 @@ paths: ligneVoie: type: string example: 21 RUE DES MARMOTS - ligneComplementDestinaire: + ligneComplementDestinataire: type: string nullable: true example: @@ -2744,7 +2790,7 @@ paths: "/api/v2/etudiants": get: tags: - - Statut étudiant + - Éducation et études parameters: - name: ine description: Identifiant National Étudiant (INE). Cet identifiant est unique @@ -2872,10 +2918,8 @@ paths: type: string description: | Régime de formation de l'étudiant. Il existe deux modalités différentes : - - - formation initiale : Ce champ indique que l'étudiant est en formation initiale sous statut étudiant (y compris dans le cadre de reprise d’études) ou en en apprentissage ; - - - formation continue : Ce champ indique que l'étudiant est en formation continue ou en contrat de professionalisation." + - formation initiale : Ce champ indique que l'étudiant est en formation initiale, soit dans une des situations suivantes : formation initiale classique, reprise d'études non financée sans convention et contrat d'apprentissage ; + - formation continue : Ce champ indique que l'étudiant est en formation continue ou en contrat de professionalisation." example: formation initiale enum: - formation initiale @@ -2930,7 +2974,7 @@ paths: "/api/v2/etudiants-boursiers": get: tags: - - Statut étudiant boursier + - Éducation et études parameters: - name: ine description: Identifiant National Étudiant (INE). Cet identifiant est unique diff --git a/config/application.rb b/config/application.rb index c9bdb4354..182023b30 100644 --- a/config/application.rb +++ b/config/application.rb @@ -46,5 +46,7 @@ class Application < Rails::Application config.assets.version = 'v3' config.cache_store = :redis_cache_store, config_for(:cache_redis) + + config.active_support.to_time_preserves_timezone = :zone end end diff --git a/config/cancelled_open_bureau_dates.yml b/config/cancelled_open_bureau_dates.yml new file mode 100644 index 000000000..75339db72 --- /dev/null +++ b/config/cancelled_open_bureau_dates.yml @@ -0,0 +1 @@ +- '2024-11-19' diff --git a/config/credentials/production.yml.enc b/config/credentials/production.yml.enc index ac7109a30..224505042 100644 --- a/config/credentials/production.yml.enc +++ b/config/credentials/production.yml.enc @@ -1 +1 @@ -cyqcLEHJyBbNsgb2zsAnB+0koDVPuzvGtUhvzHA9qLMqbuAuUM3HnLMDYQn1f2vZSX2ZJZsgUczgucKitTYu8YURa780+8CS/6QbI7Vo2wpxP2HyXte8CTHtWxe9aud1OUxTIHS9dDrZAr/rxmp+bw44mPdlobU3b4P/+obDIDp2DrPxSddJrV62QV8aFlKptT2gmkLJg6tRTGQpKyeBHOnHrWnmN8lrdjLxYwef6g9g2uVRmZkJm5GV0W2aZ8hOSu/jbgogqGgtPtj6Od/pzRPqKliONMNDkP7Scn9FXJad/HfF/5rdFI1JwGyUCMXS0BOiesoXaDLQwnRsbcIzwMb1N2okhHuEJb0nrDWZMjS63kqN6epydS0mTQRHtkjpsDf8tjo7jHCaEtwccgcisRzFQIGaz4CRq4bzu8AETedWmV+97Yna7bhrtmYvwrQDU01RxoVulTed/at0CJ3PQBv+suv6xI93m9e0d2C8KnXYrQClXyuJTm/v7aTSm8aGv64ry87JNotg69L2ABWZYe5mm5xg9J9wDfXDtJkehQ8xKTqe/jw1RdVXWlodlxzeZCamgtnCQdrA6T8a4AWx0eCLOVQR/76gLqJ/b5JawvA9kqBbCLH7ehdCH2uiag2jkrOVzascENra81cY+x1wLEdFvo8viYceJxPB1WyvDp8cyRHooA4NbIppefRzTetb6vJbADe9gLcg+zJt+SDnQh/ES1gWQFd6hAhjhpjvumtpHflUwm/f1Boz34dOQJvTQlwmvfAluq7wM5PZYX2RiAWvhEBWvCKOmZRdImwAxkCZTnnjGifGG2/jcObfMIvh2VJzKYeph+dksjPG28DS4hClmR1BKgWkTcdzGsURy/UC2F7bIkXZ8ecZTmYEyDJU/2NxWcjPRAin8r2hTLaXcNJ2n94hUHzi49N6FSiljXK4AQ2iaZ22isku7R1BgCraP1HNxyevmNY0r195II8/Hc8sjlb4itgiZ00kk5SSU1UpoSNJBP5bVLN5flJALk42sQ1DCt2mogHzbzFu2J2dV1be+SUmEWqRjN6PbMEQ5XUmqrSD+kaPtDb/7tsJ8mbYnBsf2UukrCtMWti4QTKsmAX+LmWtQL8DhqpXUXH2D2N9QKTbLpSBNxLy2DDrfHNkixmagElkTEdcjfoCx64X/BH0V5ifAoTbXguORROU395kzRp56di8hbivzLZexEjJOFsq4vFW5i/xmI0xqOuC9CFcgN/s184070l9izuas9eeVwTfQ4iBK5piNFaIZNnn9b28QhjGQaUH+gkAfUUx7Sl6ftCcxOw98lYIBsr4CUZSIkujdMX7lZNbGv3ciFrgN9v8E7mI/6bc25xZp0OovICvHTwLu8ID1aDhBgtE49QQzETHS4ubUUWo6AgxvyIuQ+hIYneBB0OU2cuHJXDun4a63z+ssVBwPoN2/xOo7dIDZ9sboq5A5SBFR1JNq8vUoV3FTxCI9cIQqslris5a5vgpMvVS3rBsyt9G/retDopv1GM4WRFaqNyFMA9PikaYyRADbw7X/6WwO2HQjRlpIjuRBlf7/f5Tmv060rkwdNR/NVWSnT1RTYtszeJJVUNTfMElFzYomvawwLJ+819Aw19X79lem1dNZxRiCFy0V3dXuKv53SGTEz0QwnVBrOflZLClEBMMfnF3yNxpA5pRY3CHRDHdsIhIYhQT96i+guY0KwTrKo8sTOWqF6UJXfNR8bHsbzU4NuE0eHH1Az9HUyB14dqgl3W2yT7orCFi388bTozLoPnnNXkAIF6/h32E9eMdEzeAz7l3FKC+hIbbSjo1TlE7yxu8Q2pFYuIKuvx/7DvEQ+ltG7TWaFeigR5svJ7ukBncKGkqyAZriOr+HgnA2qMUMapOMRen4Wu57quL23JI33thuXOcL2JN2UGl/J+x4sp3/I4NFJYT4cUNyPqIXrul4CDoItGaMK0yKELkZavBte8Jn51HDwQ3QDlLYfIvjapXOQrr1GPK2KGAwNKhO9tnEZFbnAfnvNzXLsX/LSd363D2lRCaGpWItdNy2kg6hNiIX5ps0I6T6hhEE4eBLnEd52KxZczmKhv0YgJlIhU9br8OE8fpO1dtnt4lvbqpKCE/RLVR9bOLBXQBipiQAWKiC8vJZs0IQAF8mj/0sqny6ytu0REAFaHANDGUFuF/v8x31LMauV2pE0CB3xpr5GlYapgzJygn6tAzSRjxnW3chhP0F1XwUgFGGN4a3XHyS1xm+4ZKsSqu76TnF4HzwLE2peYchoaO9gWw1A6EytoG7c2Pi+ZKUDLRInOplFe2jxZkgJ0WYHbgbzFBakTqEasnKZMPOHAOh9dJAn3dqxly2nyUtNcMzkk7Pb+5gPQbLG68uSwLHCljHdatNqTseME2XO+2Vhs8bM0Cixn3z0LWbk7fda7MrVGA1O7VjLw72VbJrfsqE/O6GBLURCodgOMj7LLw8xsQIHcwxCOjbMPF6R/u2DV6592VdzAeiqwtsriFTmDxexwwPOQgV6M7tZ1zBiRTGj8n2+ZimedV428wGmaYKO1fn8U2tyJlaWLJsaeiowTEpv22LHyvGJYWlZAaCv9IgZsi/z2xjasDDLXV4/5d1sEmca0sD/R1kiK0XBOldyFM--wZkWHgUfL6lLzi0R--/f5HhUSn4ZFkcAzEAzHasg== \ No newline at end of file +ZmObCkeMC6ggIaMXD3KAtos2LbhrxUN9QOex7gPbunclfFm6n0W0PlE5BqT5ME4o5jDrS7YrsJIjz908pYJO+ksonVnObTMIZtbPGflcEIAoQaYkEHLqOYpya0tDabBYoEcDLUvMJfvpQc0M9HN81CEgeKnvOyAlhFTkd42TWTu3rtXHsAC11DGGScS/Bv2DMDv+ak3XtTmDZy0mZUU+zeCyzAKX0jMLAfF9mKpMd1Im4eRTSzVNUbMT4F0SokOokAM9aoziC80u9R3OyCXzGIBJpZgv6M0xYhMhoF656qfKrnTFH8qwjU2ozJ5Lv7GWviryBb0PB6cxByG93qAK7zCh/lWVpyEfbyM3Ir56/0VhM5bHwFt/MDn0zDxi4A1VeVA6zGbKdCk67FWQzvyeFj7N+mEtX1m5gqksqL+si3bOI5IbJnTkotRyZacHGuDF1lyoFbuT83QdRRfG2SPqEswvdCkwKF0w9N9Tp9TPYTcIILOet/T5S6WfraHMVezH2ulJbAZwRYIfiEiGulIFE/nJP1dRo7s/cWbHT5P9zHbkyELq7eFVgxAlF0KWs88W9770pl+8apQIaSJLwtcd0xaUTEcT1HM/tPcMkdp67C5sSG6qVLznsIS+MgKTejjkEHc6hBZKsiM/n/n6ce6IkKCKOTeOpM9v7ON8Nx/RejIgkLYHqBU8I34WoooQFsTX/C0rWJckhCVN/pOLmRvSx9IxJ6OgobOzkaWv+ChQNK1d8SzUkSNDwqGAoMzYGbmYWahTizq/7CMW7OfIlYKJDrNq2MJKV/+fDgGuIBalZ75y75sveEGrMXBILUTCYBDVL/eKb0EBjfNKAA8CTspK55JY3buQlRzAO6pcTYdZnMhTIpGK7Ayu2JHRyMiy6T8QAA462Oi+fBYNmymX/76Ynon3K4oMo4d5cn0ZcRp+UNu+hcGkPY65zUx/QsltiJpMm9VXBAn7cZVbICbuwAG/tYJY/5ijk2lXiji5iS/kFs0rlHg0kSuBZk8pze5WshYG/UbNX++osJS4LW0w+RIfDHVsJIgSfvH/7QxrPX7IERoJ4BoeaCeTqTp+nKYjF5Uh2vUqVBgo1Bw2vSyWTa0//6TdZfDUIjilmGnn+uxU/rfOsRFsReyv+ZvoQ23UpanrzHZsnz7tf48lM8qoca16KKVczJtJK6yZCgf05AC7ysPKL4AE/OYGv7lfX+6RdqxZY0IKb3GO6LfmrSezPsTxT+YfKrH58hK/LhhW2XTVcNtv/XhQ8MrjdX8N8mlCmM9f5ReXczMirRr0HyCMl1YD23FNg8yB1iL9KCmK5bgEfzhL/sOo3XOTCb0ispwmv55HSmTcwzDufhgURe49E/f4bS1lQvU3ntcwkMluskTmTSc5WLF/9v9PaUKl91HirL+DewzhBjweN4LzF93xZHdmrKY1M1JnCqSQjjFzl6hKVLMc4fmloFQhJxn48Z54AZodj0jfghQTZ6qjUPGdiwobyc+2TJddBRFcD6W9KKIQR8tPRzcHmmrLus4PAcIE5ZMzAV0SQOM3ConQCheMiZR4JAzxV2uM4lOxNJsAAGnI/TGEfXKnQPCWelIkVEwKV0vBNHDG2HJRySJpOPGzFphzj2r8FumJSM+La/AiIVkQrMaRFRHZJhp04ebVrVqqTC8Jqbgzl74IYthJgzoHZcWAVMKuvgcjmpgGu0T/5C2wbWyqsjsaZgK5Ib3f6Puv4IXL0avWM/rcaypO2d0u90TKUGcnJxJiuBnr9YhA8l4BlYTz8wwfrh2v0EEIctsTN7qAUGki+wmuEHNPLzPq6mfnwCyeP2CxgXxopm4keMIHQqMDG8GwxAZDXR37XsuewDjI43/3jt5blbXNlrzk2oKSXB7hpiisl8yIn7MiIBFHMjxzP6nh6saAHTTZEo7GWTcvyrG4bws20OJAryyQNQ3Ds/b6gHhAcwYQ4QX7q1oLuw2NSdj0eMskXVjgtXgmiCiYtiKqfCQ134ecHxy4cd8te5/FUKExHc0R4/E1QkIpNtyr9ChOAI8QiaIvNI9JiwVCWH6fqHdTpTS3zhaE3+CxPoBeyQvxkZMyhRcY2r8k4BX6uzdySin5El2rCHPpnUKFtJOpMXDfTUcsBCGQc1Xdh0ZMJ67Vse/Cvef1AwDejmwIf0HyX4U5ETwlrabyk34Xg6aWqTqpFzmSNgsSsKxJ1WuaOTQQ8aAsTkrU/53qEzN5kkXrjKwsw1dxLXV9bgIsnR4JdntCztKCnqyyZgTRvuGTRrTBb54rV+V7IzGyrLXODmLKU12LSZeKn+cHTRAxIlm3LRV28hRo68LvPMgTkE7VcnUkjGWsTd4edGH6M83kGM4ch+zbWEmcSOYLsl3QmPAA3GHiKrvuIwKMBPFFW6QEVuSg7W7xiER3WTqQxWPQLyS+2cB3MG/EsW604MGKIm2GtRp71vwGOvOoLUowxfUrlz0GtxC+TBqXAIERrp7oAIvp1C1+F8YNnjnfCROs36ohHfvDbUwntHubYV9hEQWAz1V6EowK9VSEmBDtz7JjYkLJRdQaNTchKOzRru3iGEyLhmn6HgkOBqwsbUxxzHT/GC42TxqDEv1QrdN4ZORYHOygXFuEVTTF6EyD4zm/v29lc2Ra3VhPKhN5kUkL7PgNW37wYSLbYDiezIM/wclQGy/bMDnKOHV0M7vj1XiIgTZdj+4fHFr1sL6VTy6tceOEIBBOIHfW+ZlSGtOc+dA9gD45qrROD8V/dXBA4JLRdF7bCeR3pkTUt1mFlmdl6CIYuyA4xpbQAOFdrijxkqNTNpR5PWHFeqiWDeRTR++rMOjBlO4eYN0Hraks5bowgDtrTU13M9qnxKIlUKzgwwxBGQFAyCcMj1WDocXrtsKSke9mrgMUCWGOaKQIIDuiaBG7kpHSWnNa2eVMrXtEWUZ/lW0eJ1gi47RlomarHZWVcVhd9KcdiTO6nJJi1y0N0fF2BDNzWIPDVAAEWSjc0tUztYYK/lLW866k+6IFI3bPcRks5qWROUb4gOn+2Ip2gxvGE7x2fFu1IcG/6BgS/wG80GrvNU7chEIHMOrbqmdbuQP2MTKh+ewcTPqS/rtdpwNf+hBcyBJEdmMrw+4LxhluFDqh2WuMC33EfC8rHwNkvr7yF9FJXJ6oJ603ASUQ6HhfM7yvCLojeJqMEd7hqMskX6lOe3kc7apfamIUKsIjnFb62L4XxjaR+UcVQvJnJF5euziyawMwtVp6kWoTHukNrWPdJa3iNp3fpwn+VfEC+l9ltNGX3Go1g7i6DuYCIVPpkrYWAMF3EkUoBnaEdMqlEQ2YtRcjG4xYIDuxMG7vQl/ucaQ31AFnV5x8LxtsF076KI1g2cSi8g0RRbVYMp7nSXu8AGoKoS+7/rAwjkfLbU8XoNhPwerTE76TGsAJqltS8XXbrgazemK8v6rIk0BBLMDtuCSKSUh7Kx6T+Zn93uTWEVCKXCdR3ikSD3vSnXOpYUN1PD9/76VuQ82A5YHJq656dOHm+7xCSc1r1shxd5ECx9uK2KTk5qT2XPvxmUXI34Vs9UJO50hal7RwlvSVxcPDtDyjcnBTJtr/ysJI9VVuScSBaHGJe3F3fFa/A+Bx1MhpluRDNyZ07/zRoL9ButRR5FVcz9dNNyFRnHKd/aLEyrhSJzZNScHuzMOvGMCd0gvINLLmd4xSndkUtimjWngSD7P00A6nDJmqECVhJ/FfJ5RU+nNoPomLMbudQId6K6m8zBKRR1ADhMKU+UEehj0FWE7TlMS96jPHM7UqMvRvoZE8ITmNKJmQOd0+qUdZNbHzAsjxmgu3LjMEJhh5RMAXlsTA98ptuxoms++bEx6AmtQmlgC+teRsSSKebP8aPr1gBNwjqIEpOrPwceaYQjbPq2r4p83LoPtQa6zVhYgB5DeiGkenOjBlqmXq4Q2oVn3+XWxXmcqlD97iW6+NC5PH5XYMdnEL/EVd0f+JwMYsJHLlEVMu1+fnWyP87FTwiFKQ5brHvD4VaCgWEwAnHFsVPxJIFdhFmF8lS1Xb+Y/odREYgcrJRVEYkklCKeGrGcHpN0Y7oa/5WQC1I+eH0lk/N8d8cLbKv6kwE1zcih81SoVae/ltgU83j2arZXsAp8AWDSe+jZZMcEZDsHm9ml6SioOW0IFLDYnhHtNOn96fZt+Agbp5BY+19W35g96pjap3S4tDnydflEsZDRomP0JXRhEk0BqggQVs3BVbq3C5kIKlm2XKjZ1BsDSDoMTvoENXgkpCLCrRxju2bLEzRIgR5C+4yMCzhLNBTBxISnKlps6XK8wF+Q3pFNdnLhBstr2C00Eqo3sWXZ8rqfVAqZ+WxMJOz6kKV2+qmyi2DKULQovWJFmQRpLFb5FR1HLz87TwmXQSKUzCh4M+CtFGsbHHsGournvmr/Jhcer9zCT0sQD1arbsccJSRaX66UAizTtTbog4ZT7JjxM3nKdHcWO3ormV1ZB8hT9Ddv+0WYgtYFv44w1SO1w8g/u2wbJ1mKosLP/045lp+cYDENGFu/06OZEQy8xIbeoDJfgYVcn9vOFwwhF8avC1+6WH+l1buXNgoppjy6BttzSYDwsUAMJ09L0pzBlvHruB2JtJGUCqjjgbFVzAmbrvpuNOSugB6GRmyz5CMX3UNZu3ZR4ubvACVxN4WYPUsTyknxjiWo2yEe409LbUqClQIbKePiU9az7bEbO5IihDpF7y8Pgg0Uw2wZkplCI2jl0vUlUD6273+rw22z1FkCh+eUNDQabe0NtSsNVVJ26t9S53oBH6Zi6agKniYkJL3bGN99a0B1xpLRMvEH7Bol3stUTI926i3VIEeRy9Bme5ICHE7rNjDr7UIUK/wcfXi4myuhJJq9uITYGJcwi4eKcaNpt6RnkJ+2fjxYaaM/DScuhzCoKDPSiV6GlvFRV2VbUyQgVcwL+e9bJsMt228OxDm6fARDuhNcc0QjpkVjMBaivVcRDHwIE59CKyKfcXWFv23y6md5s22dcr6Ip05bymqAI7PCtKf/7lBtcpbA==--tgGTVwo/lU3jhCuB--9N1N4TlMV/Rw+Vk07mxh/w== diff --git a/config/credentials/sandbox.yml.enc b/config/credentials/sandbox.yml.enc index a9fa2cd98..72a5512a2 100644 --- a/config/credentials/sandbox.yml.enc +++ b/config/credentials/sandbox.yml.enc @@ -1 +1 @@ -WXXMzkxUMGPk9DyWjuIoBM7ei3Qxi1M3mgKXW0jpEmW3DD7SJ4CVm7VnfuerOq59nDBeugTdY34h6DWSXQQ+d/ZpgxDDBX/TASWj5tBYjjYu+g7bYGsvXwYnGNJd7xnAD8zCndBAhwfQn7TXnCzhCCytrNvLen61+scndaPRNv3ipIC/ct+NlsogiEyB/3XXntZhm7Seu/2UdO5VNSFzQlW03m+6r226Tv/17oMPR8+ZF6z/jY+igJBhOQIAD8pKfSau+ju/mSJMVdKCkM+AYWQKiDHYwS5LJIKsdK3sRIIuXbDeijo2EgiwV9HniUbloD6ElDpTf0VAj4s30ZYxIJGfy0S4ZIOsmummBk+jUEoi3GqwFMNpgMRwpVVTnDdI+opVOk6trSf0F9dv2sD8j20jXBR1lrSLN/7RXgpd+iunivJ1191AxdLsDuz/nFkUye1fGDwc/lM6BaO3/ADbFVJTpg3ro7NvUt22T9uVq5X87jRLbJ2kNkKhtiz+cAaeEp5M++Lxl9kWTDgHOQY5p/YhZnuyri7yschIqyKU3KOGMxOPns+/BOpSRS+XrJwmXxRlYGqSQKgy+ryI8XC3k97/p8tSuaYbPQr9CN1x18TPxQ5quLn9rvjYVjlyOuF2bwxV3hHiqECn+y/IYTx6Mzagk1wLeixYb8Xwgu270DzyEooac15kAfGJxeeCer1Ao/UJpahJFOsc31xKeleufyUfducCO4jFEcsipVCBAvMWY9XeFGSv0byE5CO6GkFNwZIvArnKWahGkDBg7cMehp6QdvwuzxJCDUeZLXg2ESdXoFHgVFpk/o4wRBcrC1N1bNbcwhLasKisSxN02y81qeyCxuVc3cfvdPz4MPLsIRRqUzIupayramNsUI83+35+JhIA3UGCCIxt77btVFg8c77untKWHEVc5hquN1/KofSBHYAcL7C+Ja//nGCSSyPQd8dU15V1hMzA4ts8re07eEPFxkozpGMviDLO5w1iDuKb0nf5A3V+5sFhakMzL4Pdy269m43vuUXU+teop0q+nSt2/TOTqd524FU28ZTpTgR37fdp8brdKA5PrfguPJfTHWLBoo6o7mQxEcyEyLIypQe713klLK1fp6IJsKw1GwT9CJI7PQppIxCGqPKIP9uDtVNvKG0UcX05L+L4E9k88j5i7ZuCvb0P92bbMLmld1Thsx2OdGCbCDjdnDdgAJFFRDSdZmL8GbaZHRNhojQ5Q0UEJrs7P+ow+2pfl+mfxn1H8cALc6uceC+MpZqyyNp+CEzDL/gVdugmuXm5BeFKOTwomn5aZ5uZ/2NcobHyym9DyLqFhUjalN3kaR4eAGRBy0ey+SYuaSHVbLLwenKw2KPWQeitadbjOyFowwFOU5ZTnRqC5JedBLq8wYCGqdihmT0+GfvL8KMU8bE2AUSXBz4RdUdIPyeqXdXZT+L79Xf0T63FrZjSTP8AqyZh+0xrNhVycWFXGRPN3GgfisEFI9+fFSWsMqqn+1g98btMfQMBixd2H47ZXWjgpbULHVjbE7nGiaa4Dauwr72SuGvU608B2EZcgdF9SrpXCjwarJz5ntdAc3erS/I=--cnVnlQsoPPSaGR9D--QaXFsqNdQvQ/Hw7vpmCLuw== \ No newline at end of file +FxbkzH2oYkjPDgyfx3mVfNrMmRokS1Xl5eMp798p7nIanaUi2QUmUIJPsOZ+Ki4ZyVOGo6C2Lzt+lXRx5JL9y5ymmlT9jhYESv3we6QaoxevIByaaFLT4AiJ6ZzZirvRyp4su6mfuNFmj/FTV22PvQ3NXrz4H/YrYPw8T6t7pxGsXEUG0rhDw+L0I4rf4Ed+KobW2NjXAwih1U0WPKlQaYpGJmKD76hINoC5wvNNNs/3EHABWKOEpQH3JvUlqecpkYG1Ihd1sr22NXmyLzlXhuAYeQYSw4vCuxuvYmWjflDbXoGq2KyA9SbJXvRYylwjsFarNF6TEgr9geiim6XlvmEHNIGaBUYKIfQB5jV4BZ5gOf9Rntv4rzZmgJGKEynk2LGk5588dJQrE0WMSCOwJhxldQC+Z6GQe/0Eq9fO6euYs/WgdgG8HoObaHraMiQ3YK1qfsy9nxb+qCVKWWt0UaeH4B6NC+V9rmg9A8gZ1o7+NYJSyTQq0JDAOG0qCl0xikZLxqwXOgRXjWgO4Fvv91+8RwEur+1HXK8ejN6w4rawndFn2p6EN9lmq4xyd5WVT+uKt6nQ0G/yx+Zr1d7kc1VriXTgz8Rko6WfAHz3bAv4soNEqF1nluDFQ5t1Nldka8QT8qrKeNppCkc6i7At4a1WVzHY+/SDjkni2sY/q38i81S0leFzQ5ga1kys5I2Mgia3gYqtJSKEk/wdIs+rMCKO5pqF2el15v1ssvYhZr2jjlNT2RtEWEYkffDnfSa1qa58LSCZ0WNK2nT9yyO3C47q8ZqiVOk8+l1f+gevNsPLSRwjbYBuQt/rZSCAGuMliQsr2OLzc/VhEDBSFMiaAHR8YJWyTipi9XaN5CdjNjFLwqc/3HyVeVmO7joOn9HcPF6PQu49aNtrM1YUSaX0zGuEDK/G7os3gY7imGGUGRYt1YVOqWFf9J0xg1JqgupI3/4QRWQOkFGFk/aWgJNd4SdthAT+1xwdFjp3FYQ7zWvzLzKN9236TjJ2DRGD94LkdkeljlTWdStBSS0CUAHmYeuObh9reqpFjuhYcaD5vs9F3voBT5pDk0sAv6Y+F3oC5c9JamkR2XD5Hw0x/Hc9P21KTjpXUITHPV3PJPqajylUvC1y6oNZxTSPdIko8EU0LjdozsMqgdzA4nGVmDNYu6XxMEW5/tR53GVQ6krhUNvGN5Xhr/l2NKtYlubperonX/tOwIbDR7xt851+DAS4CLTlT1FVbTI0yPyqd7Uxiq6SA1tAcVKLkvUIajagZfeGum7cG4Cvu8FGCcvvcm8+xu/1q60Jni6J7GV0inCsF74TEXLoasOROql+UkwjMz2zY4++6o3EIxgo6ESGiesPbA2b776Mc1pXPtb/q7YftRZLGXRz0fYHjFkHCx4NgAukvV65Tp3mNxXEpjF+R6DspLqEqOkk0oLc+S0UCUW1uY78rwN7+V/N9rJU1Egx5dKFWhjr3eP9iF+3thN1MaHjg9CmB7dVwC+2+bmAU0JIz0UAF0PWdvlDV5S7AgFYTAa6ff48A7u7uPR2aDQZfZgompI/K3hfIIyj66m3Bgr+Ntjg9eAFdVNL/oYq2ONjXLXvOjj2xjVYNezZdQtxR+wImdI565S3LDjhg0lxbOkLmnhXIGyngDLPcy5QaIbtSkcnZauElLjCF0XwyHJjD/QCxotDUoIGmB/SsqgUfz8JzXSdhk7I7UnD1OsAzj5wqbuxOS5kPadUFZT55Lp2kirC5voa0VNT0tsAhcdm3KraZxhEwvNnj6U/6prBUpmhd9riObuEuxuIe9XQQgXNl+hULXxVetZ2lAPM4ZrQeJkh1OXKGDbXVAsGyhJl1Ojj42P1Vg7L8BCk76bKahgJDs56egI2DjkLeGJkWcnh4f2la4KNWhYhEGdeMKAvEF5dKA99uBahUDPd9wF8OaRHVTmIIHFKlNHAZ2Oy5NJV+m5JYUkHSfhKxaBnH1uUYxJOEwEEbxjlH4Lg6YNaD+3eBbP9PErWd+rn/j5ZmJwNryY7jPUt9BNy61wrfCp0Aww0mpq9M9QcxZMtlPd2p2fLxoSSYqBhWSg1CP2WAsZZPJpSQveBdM3fcXiKDKuVkg9o4uutg32WgjCzNMrZR3pTI5bm9ZKb+Fq4IdXAjILLLTclyLYDUV/VKr4NhlIcZ8L4Mos3GqrTKx/Pbe3kcOn+g2yo1+Lq+0cWDo22Coyg0BdOlGf4y6os+Frfgt+Xf8TyiHk1ecmy/D73fzGF--pR1hfy5qn2BKDerm--YWGU6sMyb9WOczKW30enzA== \ No newline at end of file diff --git a/config/credentials/staging.yml.enc b/config/credentials/staging.yml.enc index 0a007e35d..c9aedb5a2 100644 --- a/config/credentials/staging.yml.enc +++ b/config/credentials/staging.yml.enc @@ -1 +1 @@ -9JD9jNdU7DCiqe0LAHSWFuB7ANmPinU32C0Fv1YkQhItRWtWKcGo+fsbv/Z/T2UbwKB8CMBRM2zwL4sKedcWBw+uTACeA/86k1kQJXuLZO/X3XuTAf2jOLLLo11YLXBYthN2tkXl+qXH2dyOvZxjSsAc+pKKe1VZkl7+XIgikEgXZw2lSjf7RV9XS3i/QwO63XkedHuTbLTSPh4U9pCsa8oFALQzVyenBiLtgi2PIbFXdYpzdd5ZlDinWGFIz7rg2qIe2s1q0bVFjMSCi+7n7yLtS0yZy7jYVfvXBh2bOrfKGd8L+9akOG1nhWu7FaY/4wxxnlaTeN9uBqZkbVOPpecE35MYmjhpuw+PCaSiussADICqutiSPkqXpUtZHPYJ2EGcT1p6aRBU9ZQzs2eywVOp5rcbuKVVnUdEb6JLNt81OLiG0Mh3efq2q9bDTT9ygBReRqFVNr/sNq4wWPTb1dBbua8q44zJmDzL659mJZWlyPZjjIga+vrq/KfYQ7XIluZk17Fd4ESJ09a8AAYvDF1alzWsEs4ne2/SZGZHlDczrQEb4kq12h2PwKx5PNxdJQudrCR3acp8D6gjHr0XOGHcbH6jwaWe2VLXp1ovx4pf6su9JsvhJ+2wdPyeBof4vLGPhakScor8BVefVo88yYGUFvXV43NGIwbHlJYlUqv60jV17stiwKhVddUDyEdL34DJqCMYn1PuEsvAIKhVVKKPV/MPZT2PXto0QU5eD/167caa5JFMSYxNvUfIrgRAEtvhBJlnSB5psKi8DVIWt6rFPHDQoykVl6Ow5tkJCheXnggsrZX/a+SzyC6nqWXf9Dw1p1d7lIaaH+bSuiugBZTAZj5MmE9t/yOJMWmpN8+OXf4CErlcFIlphg3EBP8TTK8A44dMEzAvqABcpyCAsBi+spOg55lpmJAdbWwm+OtQ1fgOFS0CrShCIMs0gAOAaZQQKLgVaWHx93y1Fx0e5qP8B+CzxKBjZY1YgCTfPORGD71VZhOhA0X7zme9Ot0Y1DmQ04aQvqRmACrEN95pyqYZ7FWFFG1Mzy2VGb7INpeiXBaWPpaoWCdOkh7SBB+Foj6klXY1hbB+jPaxP4jqsOMheVXBLMRcJCps1Ax+mTqiMN9OHi0ibT2kGS+Ir/CuLtHTPTMD1mkHQN4PNH7HTemCdk0Fi87PAYtdG/f4IqlFAvPI5VSp04wDv1vN9iSxSVOjO6n2DULcAjhT22DHU87Lb2vsvzRNG88GoY9gGmOKiEUxkwKWV85/D3MzV376kY6R699jfsh7Ms2GiyWH5fKD3ZqS+LdN7+0bkarPdKYqtBaB/e2Gsx1YHB1l8ZW3IpXONA0s8gvH+OxJg3xNaH13m8DZKPK20ZOZWdW+3VIF/54e2NhS49D4KXutuo5xB2YGSRLpDSMoIYscJID7cc+VK2Gqmf07AlvpmUYW2S2mO5dgzu+KOPVzBkTQ+rhUsthEdUIpQXn1y94SLlxgJcMlA3deqXLfQZwKG/mNAuqmvx/t5xkMyvhz3OdGHek2Os6wesQ/t4TqkUs4iY6WHolZ0TARP+hRDRtLMdNtwP7V0vSfWSvrZut9UypfEqKlrWtiPIgpZlRaro8uQkoaweTpPR6CQJ6klnsoOQj6B7pbscg9E6X4tM15Ld8IogItn9Ted5OyxwroWUc=--ikgyIcb4z3MncQnj--HZOkrCFarVAis0DMXy0oaw== \ No newline at end of file +FTAulMWNx+44ChgUrtewtLpdQTwvfYPYVG/ONsJmG4TV2u/CG3d+vmdPrHVQH7Kh+iD/d/73T5O0pRxFz4cFHFjLA88MYDEDsHDn3ANi6RQaGULIB1Hu71y4m13AjxARNtEYKdHXQHgCfLxwzimKrSX4QoHgMyQHwhjS+lFFwn9bsJixxsNrmByivfRCQ6ryV6nWIrYfa/QnLLhlUtL9q+aNTXtCeUljn/Wqa/9oKuNCPJ6Dy4XGlIuHW5Jk2ET9bx2KIN5lBa0CaZaVo6XOs+lrVzyTHtodY2uiJPVA4b+0x8sqISXfqIYd+wULJApGN7QEvWjm1Sgw/hPGCp40rvd0waLpU2R725eS+kwWoZDyKL95v9ygDDwsXQzUxdts8OZyeoD6lJ5roIFyWld94U1adR7bBS4oX+RuOIvOjtyxfMscdkDzUsuN/ovb/uaY6xAFZklzU+zV7k/Z12VUFZGtoLUMU9+KG1Baz29EsH6AY2xfQaUi6y+oMGwA8OoYGj5Vo0i8Y5NOXwd1nJqrTnBRHhAXMsIe2h/1RINXU4rcVqtdl2PzeirvKZyvw6rKeP94aVsEChzbJqS7adsamKDai4m7ORF9WOeQC7lSgBu4KbCWgO3HgpPE0klBuj68CtpWpyNldzdq/TW/6GoyNDR0kkYWkM0fM7qDD/AbTXX/z7aomujr3cKwFPdAF5zn4IXsBPtYpxW093B5YiJbAY8ZG9B5mKHutj+t9yVC5EhPD3XbLkK2/+prHd5Qw+uBZ/G1XIN/fwfp/UgHOVNn5fnDOrHvQbvpnIY/Z/a5dwzGYx7aJjIx+Lh4BN/q7wSgINUoP3F/WMPLTuknwMmeXM9Wu9CnXvCd1ntQeoojh02THo4bS5O9Vu2vq1tbG7hXCMG+Ab2DoZVEFb7lNh1sMcUayw7wMFXuga3iyMXBigX4+DiAFaCaikdQkr2XJwNS7Xuw+Y8SqmuzJvlamFGmFsA1ljg8FT6TTRt6RIyLWJR5wpW1Xx4UMjOxP0gozDeS1zR5kMSLt+GJZQlZw68lKvv0kwtFdxRYOptnlDJhRPdLmPqC6kykCYslR2AO8zzQXEAbOKZBf6h3jzGcL0s3xDn6MxkLWKRs9xxotNEA25Dzp4spBRmqnrEY8gIiNzH8vvo04M+jGVfKXnuObCX2BUgGR9Sg6pmjJyS64nIVgYY5pymBwFWM62uqP2/ELdo7hzThbyba/SqB5n/FSELhN87bLVoLzyeoOO+ed2J2RNOKh2B0e7C41cBPvlCrmNV9/EXZj1k4n6O7enebgJzwygjkOQ44UMzqoQqAxxomOo1DCEsbROwkRYYQSIF9UbG7KipVgoYn/8arU2tJq9D7xp2fe1/pBApPSOtvH1Cvn8XiQAD8QTYVrT8Bb/vgJQvYMy9+HBwseNbXrdWtTX8+xVvjQOuUPUSLHAQWENJ8DCc93DfxRm/pDOssTtjKcIFMtTGolYnyuD+42qxscU/Mqiahdg/bC9iMsPE6kFgIoA+DacDWaMEYg2gNaq4fgk7tlZqHTL+e8+nwMbUmyib7czdywNYgDWVUSSe/jjcCUhtlWzthYTd38uFz0LWqlz4lbaBnvwhTCr6LZWExNdyMKI1Po82MoYZaBFi3LjTaK0gDoDc6TU5QAydA2zxW3yycVo1yg5X1xqfnJ+u9ZyBab62HqAMaR+lyiUaVe84EaLTpLRaSwO2ilojeoawCf7Y6+nOZbPhfuqI8wc5eDlQHpXlvCkkPQ2KIUDfle9B+qehaL3EwE4/zzQQ3fSEmHP13bWvL+Q/39imAAC0HbSfOhT2bnoCgLNY5O8GXf7ThIgqTAFrFrvm0y4NMCj4ML/RdWhH7DYpdW7+5hN7arwIM/kU9EbuvyrXRSXcNI0vEi5gunixIz++Zb5GLnvsje1dKJWF9/cWPp8Qf/2s+R8RChEeOQpyUS7KYGS51vSYE53pvxIpAiNaSXN2zbgdbwj0MUxncNlDtaHCPi8P1/MpsOXohYBjW6pxTeEeW6DCgtPCllQe0EP7FgUQ8G5w/sjY3uVrHAtVHiAWfQkT/1zMCd5RsRtnkJAn6+RxVQIqJDOGUNgKeLSOc2RrVOTxlk3nvcBwhUR86r4RIXlaeEQeMGKHrPk/NDWiubpdhnE4pJgmtdw+WxqgTwosGnsiEb9lAJ3FBgavpq9mHIweb/EuWYI9lGgy51yEVd6qbEegifw+K05HdiUxN5slvoqI1yK1h7doPn0ZFjllgv2JawBj7xoFS02XUNJHEbRRUwFeYLJ3rjF8bcqf6YKtLCmUqBdQaLB3UIy7QnjjwDhUZ0urejRKfvha4I69qga4=--3vwK8dvGCDo4Bq3H--IREQaAm34LMx0SQuHy1fVw== \ No newline at end of file diff --git a/config/credentials/test.yml.enc b/config/credentials/test.yml.enc index 997d480be..26ec8c3a3 100644 --- a/config/credentials/test.yml.enc +++ b/config/credentials/test.yml.enc @@ -1 +1 @@ -lHp2jcmiXvV33gX7o71HcUGSGUsu5Cur7gmCB6egk/Z7JWFmKLmqqH6baCEWHUMAZGsF/6P5mho9hOuhnUb5x4bMYi9k9wBnGmj/lvR9IdNcHrjZEpzWbDIVISY3rKmvFK58XBitqZ77ajhrNgLn4i4qpNU/i5q6legfMv5mfk4AKN/+hMnApCf86mGpQT7vW8GTc5Vwy3q0nE2rYuIQxGKrwGzW6Jf68OWBA0+eSj+6ELGLu0wF6CnQHYZ5yFeS8MXHMvfjH5LLc3GVVSlwKygq+3g5s/2BPbRSr1rFN6hTBw7z7eGp81FhNnoslyc4anHND6jxP4XLjKRvExlzLxZr5iLN6UoDFdAPZ0YzEJusLVrW6LHpTOY5SmcrxeYR+CQuurbe+vRmlu4Ysrq19Byf80QQqv+mUrxnr8AxnJil79lgLJ72nHilEh/DII6GCFEm+/cbkpEIn7TOU2gcJVDHWa9w0LWEQm3PNvuOebReW8pDDb6VuuoCUB3vRC/qVMaYmKO6FNpGv0C8Apa7go4xDsbznCSzuWS3nLd05sKLFU5lZNeysZhqF/uzO83EXTUUZBXM/TjIunY9D74Z8wn6cctt3aNrH8sGhdIvd1/siyZqaV1xe2igsyktMRlkO6DxPd4fOWDxNJVsamoApg0ed4xScnJa3rdExrRAkQLx6LsP/PQjXZa6BjIRvltjQ31oRJr7GYxVG9wFE37Q3x9GNCPjEy0xoAL1gwce8jB9cJbuQmvRpGTK6zCa8nqwvckz8K+AwLTbLRVnwsAo9BP8KZpfa99qI11nGImCxCYSHjTxaAhlObcofsZJZeQmxtB47vdZXWqCazw0UnJg4ettS/wPDI9YwRPJYOzs2P2XyPZGAB7CDlkoE9yQg1UQSrjI66Rm2IUy88yOqRhLtwuhcYSofpFNcAqAghHi8xsT5kmKA1VG2ktzbbetcmGX0JdXq+n9KSkrXIoM7EfD3BaHVh7v5R/nPf21J840BBa9JQb8Lqwz22V2LU12rNNCkr5oIeDypzw4WFspgZ55wTWIfDvLd9lavROC/7E25AKS0FVUnb//F2gZJcLCi4bI9J9KVE5Cax7Np2PWFvQcLvi6+ZMvWt0gmJzP/G1j3nDzw2oFlZWgw2zrQWGidsmjX8X/4plaXKgqZtyXW51/GlnsqIN3hE6NnCBp3F+3KJmPGqAXakSkXRTQ7gmuIvlb3eA4u01D+QFBIVp5Dn5u7mO04cvhs4volbF1P5etuFtTQMZa997HJWs6JKbxbD5dXHirreWx1ePxysz0R3LP8YbBsrvT9lR8JFsC3t9xK3CZGtMsy9bmsazrt80csxlB+BsyBFyntO2wdhNpzaTNAgqmQOitv1xy8YkE5SaSqRitNlvxed8rZqfoE6L56wm0Zrt9OtJxe14SW3Wf+J8dLdZfkofS9qTg42M38uQDatHFnnrcsON0/w5qMcZ7dQ3Uh1+iZ8VtiCZk--ofXTPPvApMx26e85--KCiB/DR3eRUz/seUFc5fgA== \ No newline at end of file +YjmNdlDDxPQa0FD+f39/FXCtYlrsfgE3s7ahezgeZpVmQBMAw6g9TZEYclfqeawN6mvSwmmUVOtg50/fGrLelWtZipZM34dC/s+2sEJk+jsJNon8oh2JiKmNBp+0/d/2EnpgXsSgxcq8s8x5uRG1dVyF0PsNvZzW8AHLj1BR3LjCN1BfFzGjUXFzMOLN1ULqQvNvYmdKcVLqlQAOh5G9OvFFPhY2IOfEX6zuYlpgM3F3n+tiySykeqhXSL0KLRl+xe1XxS7LIB716vI1fegQxhVaHqsv48uS+87ACSyexsMioDSJ/sW8NUQY7ggRN8aJERjIjtKrEA6ElAaEvHwGXQJqmYlqZKCzer+X8zt7xMrXToO+sEvBlAKJ1IRFixg/aWai1grMBvlnEKGKRo7N18d45JGkc2wSaEUwoRDLA0AIqXz8O3ShUpVBhGmiulT5SpWbvCOsovvTC7kqi4645W4XZLpXhBAPWqjMNhKdnOSI4pK2y4iaOYgMIRVnRpM/q9Uq0Kn/+q3VO9E6CsVofni5b7n3LNRenMNZN1R4D6LBbTZrtd+zO3W6KrD46qj32aAmU5gNJoxnGaWebcH6Csibrh12MjQfAaLnmCzqy8q04YYSN0OnFhI4LDCiZdnMTbf+/xpqMfMgEbXE2RX0TvqzxreN4vqorIlEpw9Q9bHqsfkxC7Rpx8Kr/Hs0aJ/ZN2vrqVjHD3v4GZn3JaP3UtZIXQf54nBp6fSaG533V1sjy/Q7R15k8xf7h6c6C4dkbn1osIqVI1kmGk6wkDqAz4N4BWYZC85AQ8oOqEyRRe63dWPaAhaulPcszka1nuC5LLdfLtTLrgLk0hypjTN8VA6rJ3TLMcOqToDSGCGZew+dyfKdUXFiZOm6na5OctmzJYCyJa+DplHGAN709aNT4phkFP+hcX/VnG4c0OrFVyZsPlsIbcnNfW4pG9OJyHVUGQoLXZsPcwTSX4VlVPbSekDYjO+khEODW5MVqXc/V/uxf1/Qhou9wsImsEKtLEiBW6sR6JvjyyiVlnFu5CMXphEluXzmw/k+ClwRpQ6iIhx0Ydj2GoyhtJ24ebCQmMvQkXjSd7n2i2wWE7D9eOAxjPnzCvMIrYVQ/rI+sVA9MkYyl9bT4aVQq6A5KMnG+yLSHkDwaDft9BPc8ihBJQY33Sm6ZM0BnxG7qDgIY+jY/9uVVn3qMxDR75M6gt6EHQFdI+uO+lNDXe27R9nXLR9+3crHD0Hd6NULIrLlPrLGegD9RwY0kNRPl9ovo698sKwS8vueI0XUg7qVnvNkTJiCUObTHlsU/cocBRtD5w65I6ClQ6r0I83u/98odS4uJOseqZxiDI+QpBQK/J4aI513QdFQiUcAp/SUGUGjodMOdi186ShnrwnD7hgT9M2Asjm0lSi9qtsYaRsm9xLJeRAzxjgbtpYlAJizW2r0LMrkEOXeqB5f2xpoz6h3IiBf4u8RHjzbPF/LYKwejK7AA2T6SLvTo1f1CXuoglE4b4yG1UbSQEmFEzzyfHsuK6ULS2i7ZIrpqTx1+uWXKhY6XfvIxY+aHzr27FXxVLrbhLj6y2EgeLao2THw+PRqGdWMizdjY0NGP37V96dd33QjL98UJaQbb9J0bAxzhvOThd4VeTxtFl/dCa0wLHApYHfGYdrVgIjpEC0xMd/mennJz8chTm90xPciKS772UqewGZiUCFvFQ37d/bIOr+fyikFbYfM3+yMbpy183iBg1xuWklocFpZvRe4UMo1M8xCSHvr1T5gtOxC3pu4mb5NuzmH9KT1Z2Y41TRjy9jcS4JaOG4mDvZP75q5EmTkVXDopbdIbyCf77gCCmiVmRjCOI1igzwQyh96iDDDbw4RluUCZPjgEXEVj87d5VtXhjdDkqWLekEh3oCchboNShsKAUdkk0OvkAzXq6LDjj3VljNemVAb9krhIawXm6oJiBM9rQSnN22JQjfvzAIhQYOhp7/8jJKRbnZd5M9rcJNf1MxGxnHvxUHslWRN0SzzCMuihrAc3ZmcfzHBPPwGIgCJ7s8bgF2zBD8rRQvbNBxP35rF/zKvTR4npt7FwX37DjCjXTTtmYSQvdcRzUUBFpsA2WLBCQM/FsdTx2l8K8uRCxgYdaZbCQZhPMH8FIYW3aNdqxUdWETdMagBA2exnNJO2IvTg2fe6Nrur/bzorjhgoi7KqR13RypvOQYSJn+JIHrf3EIRy1pH3l4e888/928Cv9SvF5PsfIzCxW5VW3lISQW/LDp+W4ietq2RWE8EU43byA/vtHiVRjZ1bF23Hiiyq9XWchS--1iVrN2uZYhSZST7Q--wTX5GsuCHbFXF8Ki2bYStA== \ No newline at end of file diff --git a/config/data/scopes/entreprise.yml b/config/data/scopes/entreprise.yml index a4cbff35b..05998ae27 100644 --- a/config/data/scopes/entreprise.yml +++ b/config/data/scopes/entreprise.yml @@ -19,8 +19,6 @@ - 'bilans_entreprise_bdf' - 'certificat_rge_ademe' - 'conventions_collectives' -- 'actes_inpi' -- 'bilans_inpi' - 'effectifs_acoss' - 'entreprises_artisanales' - 'eori_douanes' diff --git a/config/datapass_webhooks_entreprise.yml b/config/datapass_webhooks_entreprise.yml index 57d11f123..9e2fde121 100644 --- a/config/datapass_webhooks_entreprise.yml +++ b/config/datapass_webhooks_entreprise.yml @@ -1,14 +1,12 @@ # Check https://github.com/betagouv/signup-back/tree/master/docs/webhooks.md for all events and their details --- development: &development - created: &created {} + created: {} updated: &updated {} team_member_updated: &team_member_updated {} send_application: &send_application emails: - template: 'send_application' - - template: 'send_application_later' - when: 'in 14 days' notify: ¬ify {} review_application: &review_application {} @@ -31,7 +29,7 @@ development: &development to: - 'authorization_request.demandeur' - create: *created + create: {} update: *updated team_member_update: *team_member_updated submit: *send_application @@ -42,12 +40,7 @@ development: &development test: *development production: &production - created: &created - emails: - - template: 'embarquement_brouillon_en_attente' - on_update: true - when: 'in 14 days' - + created: {} updated: &updated {} team_member_updated: &team_member_updated {} send_application: &send_application @@ -55,20 +48,12 @@ production: &production - template: 'demande_recue' on_update: true - - template: 'reassurance_demande_recue' - on_update: true - when: 'in 14 days' - notify: ¬ify {} review_application: &review_application emails: - template: 'embarquement_modifications_demandees' on_update: true - - template: 'embarquement_relance_modifications_demandees' - on_update: true - when: 'in 14 days' - refuse_application: &refuse_application emails: - template: 'embarquement_demande_refusee' @@ -76,12 +61,6 @@ production: &production approve: &approve emails: - - template: 'enquete_satisfaction' - when: 'in 30 days' - condition_on_authorization: 'not_editor_authorization_request' - to: - - 'authorization_request.demandeur' - - template: 'embarquement_valide_to_editeur' condition_on_authorization: 'editor_authorization_request' to: @@ -146,7 +125,6 @@ production: &production to: - 'authorization_request.demandeur' - create: *created update: *updated team_member_update: *team_member_updated submit: *send_application diff --git a/config/datapass_webhooks_particulier.yml b/config/datapass_webhooks_particulier.yml index 3bfa350a1..79e4d6cdd 100644 --- a/config/datapass_webhooks_particulier.yml +++ b/config/datapass_webhooks_particulier.yml @@ -1,14 +1,12 @@ # Check https://github.com/betagouv/signup-back/tree/master/docs/webhooks.md for all events and their details --- development: &development - created: &created {} + created: {} updated: &updated {} team_member_updated: &team_member_updated {} send_application: &send_application emails: - template: 'send_application' - - template: 'send_application_later' - when: 'in 14 days' notify: ¬ify {} review_application: &review_application {} @@ -26,7 +24,7 @@ development: &development approve: &approve {} - create: *created + create: {} update: *updated team_member_update: *team_member_updated submit: *send_application @@ -37,12 +35,7 @@ development: &development test: *development production: &production - created: &created - emails: - - template: 'embarquement_brouillon_en_attente' - on_update: true - when: 'in 14 days' - + created: {} updated: &updated {} team_member_updated: &team_member_updated {} send_application: &send_application @@ -50,20 +43,12 @@ production: &production - template: 'demande_recue' on_update: true - - template: 'reassurance_demande_recue' - on_update: true - when: 'in 14 days' - notify: ¬ify {} review_application: &review_application emails: - template: 'embarquement_modifications_demandees' on_update: true - - template: 'embarquement_relance_modifications_demandees' - on_update: true - when: 'in 14 days' - refuse_application: &refuse_application emails: - template: 'embarquement_demande_refusee' @@ -71,12 +56,6 @@ production: &production approve: &approve emails: - - template: 'enquete_satisfaction' - when: 'in 30 days' - condition_on_authorization: 'not_editor_authorization_request' - to: - - 'authorization_request.demandeur' - - template: 'update_embarquement_valide_to_demandeur' only_on_update: true condition_on_authorization: 'not_editor_authorization_request' @@ -101,7 +80,6 @@ production: &production cc: - 'authorization_request.demandeur' - create: *created update: *updated team_member_update: *team_member_updated submit: *send_application diff --git a/config/endpoints/api_entreprise/10_dgfip_chiffres_affaires.yml b/config/endpoints/api_entreprise/10_dgfip_chiffres_affaires.yml index 774a620ca..48fe097b8 100644 --- a/config/endpoints/api_entreprise/10_dgfip_chiffres_affaires.yml +++ b/config/endpoints/api_entreprise/10_dgfip_chiffres_affaires.yml @@ -6,14 +6,14 @@ perimeter: entity_type_description: |+ Seuls les chiffres d'affaires des **entreprises qui vérifient les deux conditions** suivantes, sont disponibles: - - ✅ être **soumises à l'impôt sur les sociétés** selon les règles des régimes d'imposition réels, normal ou simplifié ; + - ✅ être **soumise à l'impôt sur les sociétés** selon les règles des régimes d'imposition réels, normal ou simplifié ; - ✅ avoir **transmis ses comptes annuels** aux greffes. ❌ Les entreprises aux régimes micro-BIC, micro-BNC et micro-BA (micro-entrepreneurs) ne sont pas concernées par cette API. En effet, elles ne sont pas soumises à l'impôt sur les sociétés mais relèvent de l’impôt sur le revenu. entities: - entreprises - call_id: "SIREN" + call_id: "SIRET" provider_uids: - 'dgfip' keywords: @@ -35,11 +35,11 @@ format: - Donnée structurée JSON parameters: - - Numéro de SIREN de l'entreprise + - Numéro de SIRET de l'établissement faq: - q: Quelle est la définition du chiffre d'affaires transmis ? a: |+ - **En régime réel normal**, le chiffres d'affaire correspond au montant porté en case FL du [formulaire 2052 - compte de résultat de l'exercice](https://www.impots.gouv.fr/portail/files/formulaires/2052-sd/2018/2052-sd_2117.pdf){:target="_blank"}, c'est-à-dire, le total des chiffres d'affaire nets de France et d'exportations et livraisons intracommunautaires. + **En régime réel normal**, le chiffre d'affaire correspond au montant porté en case FL du [formulaire 2052 - compte de résultat de l'exercice](https://www.impots.gouv.fr/portail/files/formulaires/2052-sd/2018/2052-sd_2117.pdf){:target="_blank"}, c'est-à-dire, le total des chiffres d'affaire nets de France et d'exportations et livraisons intracommunautaires. **En régime réel simplifié**, le chiffre d'affaires correspond à la somme des montants indiqués dans les cases 210, 214 et 218 du [formulaire 2033B - compte de résultat simplifié de l'exercice](https://www.impots.gouv.fr/portail/files/formulaires/2033-sd/2018/2033-sd_2094.pdf){:target="_blank"}, c'est-à-dire le total : - des ventes de marchandises (dont export et livraisons intracommunautaires) ; diff --git a/config/endpoints/api_entreprise/12_bdf_bilans.yml b/config/endpoints/api_entreprise/12_bdf_bilans.yml index 94ea1dee0..5f5f89cba 100644 --- a/config/endpoints/api_entreprise/12_bdf_bilans.yml +++ b/config/endpoints/api_entreprise/12_bdf_bilans.yml @@ -9,7 +9,7 @@ Même si la Banque de France connaît un ou deux bilans de l'entreprise, ces derniers ne seront pas transmis. entities: - entreprises - call_id: "SIREN" + call_id: "SIRET" provider_uids: - 'bdf' keywords: @@ -46,4 +46,4 @@ format: - Donnée structurée JSON parameters: - - Numéro de SIREN de l'unité légale. + - Numéro de SIRET de l'établissement. diff --git a/config/endpoints/api_entreprise/15_urssaf_attestation_vigilance.yml b/config/endpoints/api_entreprise/15_urssaf_attestation_vigilance.yml index c7ec70de6..0fdde6027 100644 --- a/config/endpoints/api_entreprise/15_urssaf_attestation_vigilance.yml +++ b/config/endpoints/api_entreprise/15_urssaf_attestation_vigilance.yml @@ -17,7 +17,10 @@ **Ne sont pas concernées par l'API :** - ❌ les micro-entrepreneurs qui ne sont pas en profession libérale et ❌ les artisans-commerçants. _Ces deux catégories ne sont pas appelables avec un numéro de SIREN_ ; + - ❌ les artistes-auteurs ; - ❌ les entreprises utilisant le titre-emploi-service (TESE) et ❌ les associations et fondations utilisant le chèque-emploi associatif (CEA). _Ces deux catégories ne sont pas appelables car elles ont des déclarations apériodiques_. + - ❌ les entreprises qui ne sont pas soumises à cotisations, comme ❌ les entreprises n'employant aucun salarié ou les entreprises radiées. + geographical_scope_description: |+ - ✅ France métropolitaine ; diff --git a/config/endpoints/api_entreprise/19_cnetp_attestations_cotisations_conges_payes_chomage_intemperies.yml b/config/endpoints/api_entreprise/19_cnetp_attestations_cotisations_conges_payes_chomage_intemperies.yml index 7b499f28a..111c9c273 100644 --- a/config/endpoints/api_entreprise/19_cnetp_attestations_cotisations_conges_payes_chomage_intemperies.yml +++ b/config/endpoints/api_entreprise/19_cnetp_attestations_cotisations_conges_payes_chomage_intemperies.yml @@ -5,16 +5,16 @@ position: 300 perimeter: entity_type_description: |+ - Cette API couvre les **entreprises exerçant une ou plusieurs activités entrant dans le champ d'application des conventions collectives nationales étendues des Travaux Publics et du Bâtiment** : - - ✅ Convention collective nationale des ouvriers des travaux publics du 15 décembre 1992 (étendue par arrêté du 27 mai 1993) ; - - ✅ Convention collective nationale des ETAM des travaux publics du 12 juillet 2006 (étendue par arrêté du 28 juin 2007) ; - - ✅ Convention collective nationale des cadres des travaux publics du 20 novembre 2015 (étendue par arrêté du 5 juin 2020). + Cette API couvre les **✅ entreprises de travaux publics cotisant à la caisse CNETP** (caisse nationale pour les entrepreneurs de travaux publics). Ces entreprises entrent dans le champ d'application des conventions collectives nationales des travaux publics. - Toutes les attestations sont disponibles pour les **entreprises en situation régulière** ❌ sauf pour celles qui règlent les cotisations dues à la CNETP au travers de l’URSSAF dans le cadre du Titre Emploi Service Entreprise (TESE). + **Ne sont pas concernées par cette API :** + - ❌ **les entreprises du bâtiment** qui relèvent des [autres caisses du réseau CIBTP France](#caisses-cibtp) dont l'attestation doit être récupérée avec l'[API de la CIBTP](<%= endpoint_path(uid: 'cibtp/attestations_cotisations_conges_payes_chomage_intemperies') %>) ; + - ❌ **les entreprises qui règlent les cotisations dues à la CNETP au travers de l’URSSAF dans le cadre du Titre Emploi Service Entreprise (TESE)** et dont le système d'information de la CNETP n'a pas l'attestation. + + ***️⃣ Sont en partie concernées par cette API**, les quelques entreprises relevant à la fois du secteur du bâtiment et du secteur des travaux publics (environ 50 entreprises). Pour ces dernières, il est recommandé de faire systématiquement un appel aux deux API : cette API de la CNETP et [celle de la CIBTP](<%= endpoint_path(uid: 'cibtp/attestations_cotisations_conges_payes_chomage_intemperies') %>). know_more_description: |+ - - le [site de la CNETP](https://www.cnetp.org/category/affiliation/){:target="_blank"} est une source d'information ; - - l'[article D.3141-12 du code du travail](https://www.legifrance.gouv.fr/codes/article_lc/LEGIARTI000020572124/){:target="_blank"} définit les entreprises qui sont tenues d’adhérer auprès d'une Caisse de Congés Payés du BTP ; - Dans les entreprises exerçant une ou plusieurs activités entrant dans le champ d'application des conventions collectives nationales étendues du bâtiment et des travaux publics, le service des congés est assuré, sur la base de celles-ci, par des caisses constituées à cet effet. + - le [site de la CNETP](https://www.cnetp.org/category/affiliation/){:target="_blank"} ; + - l'[article D.3141-12 du code du travail](https://www.legifrance.gouv.fr/codes/article_lc/LEGIARTI000020572124/){:target="_blank"} qui définit les entreprises qui sont tenues d’adhérer auprès d'une caisse de congés payés du BTP. entities: - entreprises call_id: "SIREN" @@ -33,7 +33,7 @@ - 'fraude' data: description: |+ - Cette API permet d'obtenir au format PDF une attestation délivrée à l'entreprise sous réserve que celle-ci soit à jour de ses déclarations et du paiement de cotisations congés payés et chômage-intempéries. + Cette API permet d'obtenir, au format PDF, le certificat délivré à l'entreprise sous réserve que son unité légale soit à jour de ses déclarations et du paiement de cotisations congés payés et chômage-intempéries. {:.fr-h6 .fr-mt-4w} ### Exemple d'attestation PDF : @@ -50,10 +50,31 @@
Identifiant
**Avec l'identifiant du compte utilisateur France Travail** : Cet identifiant est celui choisi par le particulier lors de la création de son espace personnel en ligne. - ⚠️ Pour utiliser cette API, il est indispensable de recouper ce paramètre d'appel avec l'identité du particulier. [Consulter les CGU spécifiques](#api_cgu). + + {:.fr-highlight.fr-highlight--caution} + > ⚠️ **Avant d'utiliser la donnée issue de l'API**, il est indispensable de vérifier que l'identifiant FranceTravail, utilisé en paramètre d'appel, correspond à l'identité du particulier. Pour cela vous devez effectuer un appel sur l'API statut demandeur d'emploi : [Consulter les CGU spécifiques](#api_cgu).Selon la politique tarifaire choisie, le calcul des tarifs est réalisé grâce au quotient familial de la Caisse d’allocations familiales (CAF) ou de la sécurité sociale agricole (MSA) et/ou du revenu fiscal de référence figurant sur l'avis d'imposition du foyer. L'API Particulier permet d'accéder facilement au quotient familial de la CAF et de la MSA. -
+