api-entreprise.yml

openapi: 3.0.0
info:
  description: "API Entreprise"
  version: "v2"
  title: "API Entreprise"
servers:
  - url: "https://entreprise.api.gouv.fr"
    description: "Environnement de production"
tags:
  - name: &tag_general "Informations générales"
  - name: &tag_financier "Informations financières"
  - name: &tag_attestations "Attestations sociales et fiscales"
  - name: &tag_certificats_professionelles "Certifications professionelles"
  - name: &tag_propriete_intellectuelle "Propriétés intellectuelle"
paths:
  /v2/actes_inpi/{siren}:
    get:
      tags:
        - *tag_general
      summary: "[INPI] Actes"
      description: "<a href='https://entreprise.api.gouv.fr/catalogue/#actes_inpi'>Documentation métier</a>"
      parameters: &only_siren_parameters
        - $ref: '#/components/parameters/Siren'
        - $ref: '#/components/parameters/Context'
        - $ref: '#/components/parameters/Recipient'
        - $ref: '#/components/parameters/Object'
      responses: &default_responses
        '200':
          description: 'OK'
          content:
            application/json: {}
        '206':
          $ref: '#/components/responses/Incomplete'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/NotFound'
        '451':
          $ref: '#/components/responses/LegalyUnavailable'
        '500':
          $ref: '#/components/responses/InternalError'
        '502':
          $ref: '#/components/responses/BadGateway'
        '503':
          $ref: '#/components/responses/ServiceUnvailable'
        '504':
          $ref: '#/components/responses/ProviderTimeout'
  /v2/entreprises/{siren}:
    get:
      tags:
        - *tag_general
      summary: "[INSEE] Données de référence d'une entreprise"
      description: "<a href='https://entreprise.api.gouv.fr/catalogue/#entreprises'>Documentation métier</a>"
      parameters:
        - $ref: '#/components/parameters/Siren'
        - $ref: '#/components/parameters/NotDiffusable'
        - $ref: '#/components/parameters/Context'
        - $ref: '#/components/parameters/Recipient'
        - $ref: '#/components/parameters/Object'
      responses: *default_responses
  /v2/etablissements/{siret}:
    get:
      tags:
        - *tag_general
      summary: "[INSEE] Données de référence d'un établissement"
      description: "<a href='https://entreprise.api.gouv.fr/catalogue/#etablissements'>Documentation métier</a>"
      parameters:
        - $ref: '#/components/parameters/Siret'
        - $ref: '#/components/parameters/NotDiffusable'
        - $ref: '#/components/parameters/Context'
        - $ref: '#/components/parameters/Recipient'
        - $ref: '#/components/parameters/Object'
      responses: *default_responses
  /v2/exercices/{siret}:
    get:
      tags:
        - *tag_financier
      summary: "[DGFIP] Chiffres d'affaires"
      description: "<a href='https://entreprise.api.gouv.fr/catalogue/#exercices'>Documentation métier</a>"
      parameters: &only_siret_parameters
        - $ref: '#/components/parameters/Siret'
        - $ref: '#/components/parameters/Context'
        - $ref: '#/components/parameters/Recipient'
        - $ref: '#/components/parameters/Object'
      responses: *default_responses
  /v2/cotisations_msa/{siret}:
    get:
      tags:
        - *tag_attestations
      summary: "[MSA] Cotisations de sécurité sociale agricole"
      description: "<a href='https://entreprise.api.gouv.fr/catalogue/#cotisations_msa'>Documentation métier</a>"
      parameters: *only_siret_parameters
      responses: *default_responses
  /v2/cartes_professionnelles_fntp/{siren}:
    get:
      tags:
        - *tag_attestations
      summary: "[FNTP] Carte professionnelle travaux publics"
      description: "<a href='https://entreprise.api.gouv.fr/catalogue/#cartes_professionnelles_fntp'>Documentation métier</a>"
      parameters: *only_siren_parameters
      responses: *default_responses
  /v2/certificats_opqibi/{siren}:
    get:
      tags:
        - *tag_certificats_professionelles
      summary: "[OPQIBI] Certification de qualification d'ingénierie"
      description: "<a href='https://entreprise.api.gouv.fr/catalogue/#certificats_opqibi'>Documentation métier</a>"
      parameters: *only_siren_parameters
      responses: *default_responses

  /v2/liasses_fiscales_dgfip/{annee}/declarations/{siren}:
    get:
      tags:
        - *tag_financier
      summary: "[DGFIP] Déclarations de résultat : liasses fiscales d'une entreprise pour une année donnée"
      description: "<a href='https://entreprise.api.gouv.fr/catalogue/#liasses_fiscales_dgfip'>Documentation métier</a>"
      parameters: &siren_year_and_email_parameters
        - $ref: '#/components/parameters/Siren'
        - $ref: '#/components/parameters/Year'
        - $ref: '#/components/parameters/Email'
        - $ref: '#/components/parameters/Context'
        - $ref: '#/components/parameters/Recipient'
        - $ref: '#/components/parameters/Object'
      responses: *default_responses
  /v2/liasses_fiscales_dgfip/{annee}/dictionnaire:
    get:
      tags:
        - *tag_financier
      summary: "[DGFIP] Déclarations de résultat : dictionnaire des liasses fiscales pour une année donnée"
      description: "<a href='https://entreprise.api.gouv.fr/catalogue/#liasses_fiscales_dgfip'>Documentation métier</a>"
      parameters:
        - $ref: '#/components/parameters/Year'
        - $ref: '#/components/parameters/Email'
        - $ref: '#/components/parameters/Context'
        - $ref: '#/components/parameters/Recipient'
        - $ref: '#/components/parameters/Object'
      responses: *default_responses

  /v2/liasses_fiscales_dgfip/{annee}/complete/{siren}:
    get:
      tags:
        - *tag_financier
      summary: "[DGFIP] Déclarations de résultat : liasses fiscales d'une entreprise et dictionnaire pour une année donnée"
      description: "<a href='https://entreprise.api.gouv.fr/catalogue/#liasses_fiscales_dgfip'>Documentation métier</a>"
      parameters: *siren_year_and_email_parameters
      responses: *default_responses

  /v2/attestations_fiscales_dgfip/{siren}:
    get:
      tags:
        - *tag_attestations
      summary: "[DGFIP] Attestation fiscale"
      description: "<a href='https://entreprise.api.gouv.fr/catalogue/#attestations_fiscales_dgfip'>Documentation métier</a>"
      parameters:
        - $ref: '#/components/parameters/Siren'
        - in: query
          name: user_id
          description: "ID de l'utilisateur physique permettant une identification auprès de la DGFIP"
          required: true
          schema:
            type: integer
        - in: query
          name: siren_is
          description: "Si l'entreprise appartient à un groupe IS: renseignez avec le siren de cette entreprise"
          schema:
            type: string
        - in: query
          name: siren_tva
          description: "Si l'entreprise appartient à un groupe TVA: renseignez avec le siren de cette entreprise"
          schema:
            type: string
        - $ref: '#/components/parameters/Context'
        - $ref: '#/components/parameters/Recipient'
        - $ref: '#/components/parameters/Object'
      responses: *default_responses

  /v2/attestations_sociales_acoss/{siren}:
    get:
      tags:
        - *tag_attestations
      summary: "[ACOSS] Attestation de vigilance"
      description: "<a href='https://entreprise.api.gouv.fr/catalogue/#attestations_sociales_acoss'>Documentation métier</a>"
      parameters: *only_siren_parameters
      responses: *default_responses

  /v2/attestations_agefiph/{siret}:
    get:
      tags:
        - *tag_attestations
      summary: "[AGEFIPH] Conformité emploi des travailleurs handicapés"
      description: "<a href='https://entreprise.api.gouv.fr/catalogue/#attestations_agefiph'>Documentation métier</a>"
      parameters: *only_siret_parameters
      responses: *default_responses

  /v2/eligibilites_cotisation_retraite_probtp/{siret}:
    get:
      tags:
        - *tag_attestations
      summary: "[PROBTP] Cotisations retraite bâtiment : savoir si un établissement est à jour dans ses cotisations"
      description: "<a href='https://entreprise.api.gouv.fr/catalogue/#attestations_cotisation_retraite_probtp'>Documentation métier</a>"
      parameters: *only_siret_parameters
      responses: *default_responses

  /v2/attestations_cotisation_retraite_probtp/{siret}:
    get:
      tags:
        - *tag_attestations
      summary: "[PROBTP] Cotisations retraite bâtiment : attestation d'un établissement"
      description: "<a href='https://entreprise.api.gouv.fr/catalogue/#attestations_cotisation_retraite_probtp'>Documentation métier</a>"
      parameters: *only_siret_parameters
      responses: *default_responses

  /v2/certificats_qualibat/{siret}:
    get:
      tags:
        - *tag_certificats_professionelles
      summary: "[QUALIBAT] Certificat de qualification bâtiment"
      description: "<a href='https://entreprise.api.gouv.fr/catalogue/#certificats_qualibat'>Documentation métier</a>"
      parameters: *only_siret_parameters
      responses: *default_responses

  /v2/extraits_rcs_infogreffe/{siren}:
    get:
      tags:
        - *tag_general
      summary: "[INFOGREFFE] Extrait RCS"
      description: "<a href='https://entreprise.api.gouv.fr/catalogue/#extrait_rcs_infogreffe'>Documentation métier</a>"
      parameters: *only_siren_parameters
      responses: *default_responses

  /v2/associations/{association_id}:
    get:
      tags:
        - *tag_general
      summary: "[RNA] Informations déclaratives d’une association"
      description: "<a href='https://entreprise.api.gouv.fr/catalogue/#associations'>Documentation métier</a>"
      parameters: &association_parameters
        - $ref: '#/components/parameters/AssociationId'
        - $ref: '#/components/parameters/Context'
        - $ref: '#/components/parameters/Recipient'
        - $ref: '#/components/parameters/Object'
      responses: *default_responses

  /v2/documents_associations/{association_id}:
    get:
      tags:
        - *tag_general
      summary: "[RNA] Divers documents d'une association"
      description: "<a href='https://entreprise.api.gouv.fr/catalogue/#documents_associations'>Documentation métier</a>"
      parameters: *association_parameters
      responses: *default_responses

  /v2/certificats_cnetp/{siren}:
    get:
      tags:
        - *tag_attestations
      summary: "[CNETP] Cotisations congés payés & chômage intempéries"
      description: "<a href='https://entreprise.api.gouv.fr/catalogue/#certificats_cnetp'>Documentation métier</a>"
      parameters: *only_siren_parameters
      responses: *default_responses

  /v2/certificats_rge_ademe/{siret}:
    get:
      tags:
        - *tag_certificats_professionelles
      summary: "[ADEME] Certification RGE"
      description: "<a href='https://entreprise.api.gouv.fr/catalogue/#certificats_rge_ademe'>Documentation métier</a>"
      parameters: *only_siret_parameters
      responses: *default_responses

  /v2/extraits_courts_inpi/{siren}:
    get:
      tags:
        - *tag_propriete_intellectuelle
      summary: "[INPI] Brevets, modèles et marques déposés"
      description: "<a href='https://entreprise.api.gouv.fr/catalogue/#extraits_courts_inpi'>Documentation métier</a>"
      parameters: *only_siren_parameters
      responses: *default_responses

  /v2/bilans_inpi/{siren}:
    get:
      tags:
        - *tag_financier
      summary: "[INPI] Bilan annuels"
      description: "<a href='https://entreprise.api.gouv.fr/catalogue/#bilans_inpi'>Documentation métier</a>"
      parameters: *only_siren_parameters
      responses: *default_responses

  /v2/bilans_entreprises_bdf/{siren}:
    get:
      tags:
        - *tag_financier
      summary: "[BDF] 3 derniers bilans annuels"
      description: "<a href='https://entreprise.api.gouv.fr/catalogue/#bilans_inpi'>Documentation métier</a>"
      parameters: *only_siren_parameters
      responses: *default_responses

components:
  parameters:
    Context:
      in: query
      name: context
      required: true
      description: "Le cadre dans lequel l’appel est réalisé"
      schema:
        type: string
      examples:
        default:
          value: "Test de l'API"
          summary: "Test de l'API"
        aides_publiques:
          value: "Aides publiques"
        marches_publics:
          value: "Marchés publics"

    Recipient:
      in: query
      name: recipient
      required: true
      schema:
        type: string
      description: "Bénéficiaire de l’appel"
      examples:
        dinum:
          value: "Entreprise"
          summary: "Identifiant de votre entreprise"

    Object:
      in: query
      name: object
      required: true
      schema:
        type: string
      description: "Pourquoi l’appel est réalisé ou identifiant de dossier ou procédure"
      examples:
        test:
          value: "Test API"

    Siren:
      in: path
      name: siren
      description: "Siren de l'entreprise"
      required: true
      schema:
        type: string

    Siret:
      in: path
      name: siret
      description: "Siret de l'établissement"
      required: true
      schema:
        type: string

    AssociationId:
      in: path
      name: association_id
      description: "Siret de l'association our le numéro RNA"
      required: true
      schema:
        type: string

    NotDiffusable:
      in: query
      name: non_diffusables
      description: "Inclure les entreprises non diffusables"
      schema:
        type: boolean
        default: false
      required: false

    Year:
      in: path
      name: annee
      description: "Année"
      schema:
        type: string
      required: true

    Email:
      in: query
      name: email
      description: "Email de l'utilisateur faisant la demande"
      schema:
        type: string
      required: false

  responses:
    Incomplete:
      description: "Réponse incomplete - Un des fournisseurs de données a renvoyé une erreur, la réponse est incomplète (les valeurs concernées contiennent le message par défaut: Donnée indisponible)"
      content:
        application/json: {}

    BadRequest:
      description: "Mauvaise requête"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            - code: '400'
            - message: "Le format de la requête est incorrecte"

    Unauthorized:
      description: "Non authorisé"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            - code: '401'
            - message: "Token invalide ou manquant"

    Forbidden:
      description: "Interdit"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            - code: '403'
            - message: "Votre jeton ne vous donne pas accès à cette ressource"

    NotFound:
      description: "Non trouvé"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            - code: '404'
            - message: "La ressource demandée n'a pas été trouvée"

    UnprocessableEntity:
      description: "Entité non traitable"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            - code: '422'
            - message: "Le format de la donnée passée en paramètre n'est pas accepté"

    LegalyUnavailable:
      description: "Indisponible pour des raisons légales"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            - code: '451'
            - message: "Une entreprise est non diffusée par l'INSEE"

    InternalError:
      description: "Erreur interne"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            - code: '4500'
            - message: "Une erreur interne est survenue"

    BadGateway:
      description: "Passerelle incorrecte"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            - code: '502'
            - message: "Mauvaise réponse envoyée par le fournisseur de données"

    ServiceUnvailable:
      description: "Service non disponible"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            - code: '503'
            - message: "Service temporairement indisponible ou en maintenance"

    ProviderTimeout:
      description: "Intermédiaire hors délai"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            - code: '504'
            - message: "Le(s) producteur(s) de données ont mis trop de temps à répondre, nous limitons notre temps d'attente de leur retour à 10 secondes."

  schemas:
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
  securitySchemes:
    jwt_bearer_token:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: "Token d'authentification JWT"
security:
  - jwt_bearer_token: []