Aller au contenu
Documentation de la Plateforme

Rechercher une unité légale par sa dénomination

GET
/v1/sirene/unites-legales
curl --request GET \
  --url 'https://donnees-publiques.api.example.internal/v1/sirene/unites-legales?q=example&etatAdministratif=ACTIVE&limite=20' \
  --header 'Authorization: Bearer <token>'

UNE AIDE AU RAPPROCHEMENT : le service rend des candidats du répertoire, ordonnés par proximité de dénomination.

Autorisations

Section intitulée « Autorisations »

Paramètres

Section intitulée « Paramètres »

Paramètres (query)

Section intitulée « Paramètres (query) »
q
required
string
>= 3 characters <= 200 characters

Dénomination recherchée, complète ou partielle.

etatAdministratif
string
Allowed values: ACTIVE CESSEE
curseur
string
<= 500 characters

Curseur opaque de la page suivante, servi par la page précédente.

limite
integer
default: 20 >= 1 <= 100

Réponses

Section intitulée « Réponses »

200

Section intitulée « 200 »

La page de candidats, avec sa provenance.

Media typeapplication/json
object
provenance
required

Les contreparties de la Licence Ouverte 2.0, portées par chaque réponse : la source est nommée, l’adresse du concédant est donnée, la date de dernière mise à jour est dite, et la réutilisation n’est ni officielle ni cautionnée par le producteur.

object
jeu
required
string
Allowed values: SIRENE BAN
producteur
required

Le producteur du jeu, tel qu’il se nomme — « Insee » pour Sirene ; pour la BAN, le partenariat qui la produit (Ministère de la Transition écologique, IGN, ANCT). Une mention de source inexacte est un manquement à la licence.

string
urlDuConcedant
required

L’adresse du concédant, que l’attribution due par la Licence Ouverte réclame au même titre que la source et la date de dernière mise à jour.

string format: uri
licence
required
string
Allowed value: Licence Ouverte 2.0
dateDeFraicheur
required

La date du dernier chargement réussi du jeu servi.

string format: date-time
elements
required
Array<object>

L’unité légale telle que publiée par l’Insee — les champs servis sont une projection du jeu, jamais un enrichissement.

object
siren
required
string
/^[0-9]{9}$/
denomination
required

Dénomination de l’unité légale, ou nom d’usage pour une personne physique.

string
etatAdministratif
required
string
Allowed values: ACTIVE CESSEE
categorieJuridique

Code de la nomenclature Insee des catégories juridiques.

string
dateCreation
string format: date
siretDuSiege
string
/^[0-9]{14}$/
pagination
required

Pagination par curseur opaque ; l’absence de curseurSuivant clôt la liste.

object
curseurSuivant
string
<= 500 characters
Example
{
  "provenance": {
    "jeu": "SIRENE",
    "licence": "Licence Ouverte 2.0"
  },
  "elements": [
    {
      "etatAdministratif": "ACTIVE"
    }
  ]
}

401

Section intitulée « 401 »

Jeton absent, invalide ou expiré.

Media typeapplication/problem+json

Erreur au format « problème » (RFC 9457).

object
type
string format: uri-reference
title
required
string
status
required
integer
detail
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}

403

Section intitulée « 403 »

Jeton valide, permission refusée par le PEP.

Media typeapplication/problem+json

Erreur au format « problème » (RFC 9457).

object
type
string format: uri-reference
title
required
string
status
required
integer
detail
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}

default

Section intitulée « default »

Toute autre erreur, au format problème.

Media typeapplication/problem+json

Erreur au format « problème » (RFC 9457).

object
type
string format: uri-reference
title
required
string
status
required
integer
detail
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}