Register record·API·FR·AGENCYSTALE · checked 5d ago
A
Individual Citizen Data APIAPI Particulier
API ParticulierIndividual Citizen Data API
API Particulier is a bundle of APIs providing access to administrative data concerning individuals, made available by Etalab, the French public sector open-data agency. It allows authorized organizations, upon obtaining a key, to retrieve information such as the CAF and MSA family quotient, unemployment jobseeker status, and school enrollment certificates for primary and secondary students, among other administrative attestations. The service is designed to simplify administrative procedures by letting public and private bodies verify a citizen's situation directly from authoritative sources rather than requesting paper documents from the individual concerned. Access requires prior registration and authorization.## Qu'est-ce que l'API Particulier ? L'[API Particulier](https://particulier.api.gouv.fr) est **un bouquet d'API donnant accès à des données administratives des particuliers** : quotient familial CAF & MSA, statut demandeur d’emploi, certificat de scolarité des élèves du primaire, du secondaire et…
employmentsocial-security
Trust score
How is this computed?64
good
Weighted across five axes. Tap a ring for what it measures.
Data schema (26 fields)
Filterable via the API (25)
providerrecipientdelegation_idimmatriculationnomNaissancenomUsageprenoms[]anneeDateNaissancemoisDateNaissancejourDateNaissancesexeEtatCivilcodeCogInseePaysNaissancecodeCogInseeCommuneNaissancenomCommuneNaissancecodeCogInseeDepartementNaissanceanneemoiscampaignYearineidentifiantcodeEtablissementanneeScolairedegreEtablissementcodesBcnDepartements[]codesBcnRegions[]
| Field | Type | Description |
|---|---|---|
| provider | string | Identifiant du fournisseur (tel que retourné par `/api/pings`) |
| recipient | string | SIRET of the administration receiving the data."**Bénéficiaire de l’appel** SIRET de l’administration destinatrice des données." |
| delegation_idDelegation id | string | "**Identifiant de la délégation éditeur** UUID d’une délégation précise, réservé aux jetons éditeur. Optionnel : requis uniquement lorsque plusieurs délégations actives existent pour le même `recipient`, afin de lever l’ambiguïté (cf. erreur 00212)." |
| immatriculation | string | Vehicle registration identifier (license plate).Identifiant de l'immatriculation du véhicule. |
| nomNaissanceNom naissance | string | Birth name (family name) as shown on official civil records.**Nom de naissance, également appelé nom de famille**. Le 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. En cas de cha |
| nomUsageNom usage | string | Usual name used in daily life, if different from birth name.**Nom d'usage**. Si 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 |
| prenoms[] | array | List of the person's given names.**Liste des prénoms**. Fournir plusieurs prénoms maximise les chances que l'API retrouve le particulier car cela permet de limiter le risque d’homonymie. |
| anneeDateNaissanceAnnee date naissance | integer | Year of birth of the person.**Année de naissance**. Pour 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. |
| moisDateNaissanceMois date naissance | integer | Month of birth of the person.**Mois de naissance**. Cette valeur est ignorée si le paramètre 'anneeDateNaissance' est vide. |
| jourDateNaissanceJour date naissance | integer | Day of birth of the person.**Jour de naissance**. Cette valeur est ignorée si le paramètre 'moisDateNaissance' ou le paramètre 'anneeDateNaissance' est vide." |
| sexeEtatCivilSexe etat civil | string | Sex as recorded on civil status documents ('M' or 'F').**Sexe de la personne tel qu'indiqué sur les actes d'état civil**, comme par exemple l'acte de naissance ou de mariage. Dans 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'). Dans le ca |
| codeCogInseePaysNaissanceCode cog insee pays naissance | string | 5-digit INSEE code of the country of birth.**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. |
| codeCogInseeCommuneNaissanceCode cog insee commune naissance | string | 5-digit INSEE code of the municipality of birth.**Code Insee à 5 chiffres de la commune de naissance**. Pour 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 (t |
| nomCommuneNaissanceNom commune naissance | string | Full name of the municipality of birth.**Nom en toute lettre de la commune de naissance**. Pour 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 'codeCogInseeCommuneNais |
| codeCogInseeDepartementNaissanceCode cog insee departement naissance | string | INSEE code of the department of birth.**Code INSEE du département de naissance**. Pour 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é, |
| annee | integer | Year of the requested family quotient (defaults to current year).Année du quotient familial recherché. Si l'année n'est pas renseignée, l'année utilisée par défaut est celle en cours. L'API permet d'accéder à un historique de maximum 2 ans. |
| mois | integer | Month of the requested family quotient (defaults to current month).Mois du quotient familial recherché. Si le mois n'est pas renseigné, le mois utilisé par défaut est celui en cours. |
| campaignYearCampaign year | integer | Starting year of the school campaign being requested.**Année de référence de la campagne scolaire** (paramètre optionnel). Année de début de la campagne scolaire recherchée. Par exemple, l'année scolaire 2025-2026 est représentée par `2025`. Les données sont disponibles à partir de la campagne 2021-2022. La fiabilité des données augmente avec les an |
| ine | string | National Student Identifier (INE), unique to each French student.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 |
| identifiant | string | France Travail user identifier chosen when creating an online account.Identifiant France Travail choisi par le particulier lors de la création de son espace personnel en ligne. |
| codeEtablissementCode etablissement | string | UAI code identifying the school where the student is enrolled.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 r |
| anneeScolaireAnnee scolaire | string | Requested school year, formatted as YYYY-YYYY or YYYY.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_en |
| degreEtablissementDegre etablissement | string | School level: 1D for primary schools, 2D for secondary schools.Degré de l'établissement scolaire : 1D pour le premier degré (écoles maternelles et élémentaires) ou 2D pour le second degré (collèges et lycées). |
| codesBcnDepartements[]Codes bcn departements[] | array | List of BCN department codes defining the search scope.Liste des codes BCN des départements du périmètre de recherche. Exactement un type de périmètre doit être fourni. Référentiel : [N_DEPARTEMENT](https://bcn.depp.education.fr/bcn/workspace/viewTable/n/N_DEPARTEMENT) |
| codesBcnRegions[]Codes bcn regions[] | array | List of BCN academic region codes defining the search scope.Liste des codes BCN des régions académiques du périmètre de recherche. Exactement un type de périmètre doit être fourni. Référentiel : [N_REGION_ACADEMIQUE](https://bcn.depp.education.fr/bcn/workspace/viewTable/n/N_REGION_ACADEMIQUE) |
| errorsError | array<object> | List of error objects returned by the API call.List of error objects returned by the API call. |
Schema captured from openapi 26 days ago.
Verification Status
Using the API
Configuration
- Base URL
- https://particulier.api.gouv.fr
- Format
- openapi
License
Terms stated by the source (not a recognized license):
https://github.com/betagouv/api-particulier/blob/master/LICENSE
Query examples
Stored only in this browser. Runs go directly from your browser to the API — the key is never sent through our servers.
curl -s 'https://particulier.api.gouv.fr/open-api-without-deprecated-paths.yml' -H 'Accept: application/json'Machine-readable API description (use it to generate clients).
Machine-readable & source
Embed this badge in a README or wiki — it always shows the latest verification state and quality tier.