API Particulier

Producteur : DINUM

Accédez à des données de plusieurs administrations pour simplifier les démarches de vos usagers (revenu fiscal de référence, quotient familial, statut demandeur d’emploi, statut étudiant et étudiant boursier...)

This is a hidden anchor. It is a trick to avoid having the header hiding the top of the page.

Description

L'API Particulier (En savoir plus sur les API ) est un bouquet de données proposé pour simplifier les démarches administratives. L'API Particulier permet d'obtenir une multitude de données provenant d'administration différentes dans le cadre de démarches en ligne (appelée aussi formulaires en ligne ou téléservices). Un usage dans les logiciels métiers est aussi possible.

Avantages pour les administrations et collectivités

  • Les informations sont certifiées par le fournisseur de données, il n'y a plus de saisie des données à effectuer.
    Ville de Clamart
    Aurélie Coutant, directrice de la relation usagers
    Maintenant que le traitement est automatisé, nous avons enfin le temps de mieux accompagner les usagers en difficulté, de leur expliquer plus largement les prestations auxquelles ils peuvent avoir accès.

Avantages pour les usagers :

  • La démarche est réalisable 100% en ligne mais aussi en guichet.
  • Plus besoin de rassembler les documents demandés ou de saisir des informations déjà connues de l'administration.
    Ville de Clamart
    Simon-Pierre Chalvidan, directeur général adjoint des services
    En 2014, nos usagers prenaient une demi-journée de congés pour effectuer leurs démarches en mairie. Aujourd'hui, ils les effectuent en ligne en 5 minutes.
DonnéeDescriptionAPI ParticulierAPI FranceConnect
Données fiscales (DGFiP)Revenu fiscal de référence, déclarants, nombre de parts
Quotient familial (CNAF)Quotient familial, composition familialeFin 2022
Statut étudiant (MESRI)Statut, établissement
Statut étudiant boursier (CNOUS)Statut, niveau de bourse
Statut demandeur d'emploi (Pôle Emploi)Statut et catégorie (A,B,C,D)En cours de test
Indemnités demandeur d'emploià définirMai 2022En cours de test
Statut CSSà définirJuin 2022Juin 2022
Statut RSAà définirJuin 2022Juin 2022
Statut élève scolariséà définirFin-2022En cours d'étude

En savoir plus sur les API et les API France Connectées :

Les API   les API France Connectées  

-> Il est suggéré d'utiliser directement, si elles existent, les API classiques (France connectées ou non) si vous souhaitez accéder à une seule source de données.

  • J'identifie les données que j'aimerais utiliser pour un cas d'usage donné.
  • Je consulte la documentation technique, et j'utilise le bac à sable pour tester les appels d'API
  • Je contacte cette adresse pour être référencé sur le cas d'usage associé et avoir un formulaire pré-rempli à disposition de mes clients.
  • Je consulte sur https://api.gouv.fr/les-api/api-particulier et les cas d’usage pour savoir si mon éditeur intègre l’API Particulier. Sinon je contacte mon éditeur et je lui transmets le lien vers la documentation technique.
  • Je clique sur "faire une demande d'habilitation", je sélectionne mon éditeur, puis le formulaire correspondant à mon besoin. Sans éditeur, je sélectionne “demande libre”.
  • Je complète mon formulaire (numéro SIRET, cadre juridique - dont délibération -, coordonnées de l'équipe, du délégué à la protection des données et du responsable de traitement)
  • Je transmets le droit d'accès (token/jeton) à l'éditeur ou à mes développeurs.

Données fiscales

Liste des données
DonnéeDescription
Etat civil du /des déclarant(s)Nom, nom de naissance, prénom(s), date de naissance
Échéances de l'avis d'impositionDate de recouvrement, date d'établissement
Situation du foyer fiscalAdresse, année de déclaration, nombre de parts, nombre de personnes à charge, situation de famille
Agrégats fiscauxRevenu brut global, revenu imposable, impôt sur le revenu net avant corrections, montant de l'impôt, revenu fiscal de référence, année de l'impôt, année des revenus

Précisions sur les données

⚠️ Attention : si vous comptez utiliser uniquement les données de la DGFIP, il convient d'utiliser l'API impôt particulier

Données complémentaires

Erreur correctif : ce scope complémentaire indique si un correctif plus récent que l'avis recherché est disponible.

Situation partielle : ce scope retourne une réponse dans un foyer marié ou pacsé, quand un décès d'un des contribuables affiche les données de l’avis avec l’indication « situation partielle ». Les références de l’autre avis sont donc nécessaires pour le consulter.

Périmètre

Seules les données des deux dernières années sont disponibles. Par exemple en 2022, il n'est pas possible d'obtenir de données sur l'année 2020.

Les déclarants du foyer fiscal sont la(le) contribuable elle(lui)-même et le(la) conjoint(e) ou partenaire de Pacs.

L’Adresse est celle connue au 1er janvier de l’année d’imposition (exemple au 1er janvier 2022 pour les revenus de 2021).

Quotient familial

Liste des données
DonnéeDescription
Quotient familialLe quotient familial (QF) du mois précédent pour la famille
Composition familialeListe des parents et des enfants de la famille (avec nom, prénoms, date de naissance).
AdresseL'adresse structurée détenue par la CAF

Précisions sur les données

Le quotient familial retourné par l'API est celui du mois de référence qui est M-1 (M= mois de l’appel). S’il n’y a pas de quotient familial calculé pour cette période de référence, l'API ne restituera pas de quotient familial.

Les données de l’API Particulier ne permettent pas encore de calculer les tarifs en établissement d'accueil du jeune enfant (crèche, multi-accueil, halte-garderie…).

-> Le Quotient Familial CAF est revu à chaque changement de situation familiale et/ou professionelle. Il prend en compte 1/12e du revenue imposable de l’année N-2 + les Prestations familiales du mois de référence divisés par le nombre de parts fiscales du foyer. Le Quotient Familiale « DGFIP » est calculé au moment de la déclaration de revenus. Il divise le revenue imposable de l’année N-1 par le nombre de part fiscale du foyer.

Statut étudiant

Liste des données
DonnéeDescription
INEIdentifiant national de l'étudiant
Inscriptions en formation continuePermet d’interroger les données des étudiants en formation continue. Données : date de début, de fin d'inscription, et code COG de la commune du lieu d'étude.
Inscriptions en formation initialePermet d’interroger les données des étudiants en formation initiale. Données : dates de début, fin d'inscription et code COG de la commune du lieu d'étude.
AdmissionsLimite la recherche aux seuls étudiants admis (non-inscrits).
EtablissementLe ou les établissements (nom et identifiant - UAI).

Précisions sur les données

Vous aurez à sélectionner des scopes de données dans votre demande. Voici leur fonctionnement :

Deux scopes sont utilisés comme "masque de données". Ces données ne seront donc pas retournées si le scope n'a pas été sélectionné.

  • "Etablissements" : renvoie le ou les établissements et code COG du lieu d'étude
  • "INE (Identifiant National Etudiant)"

Trois scopes ont été réalisés pour ne travailler que sur une population restreinte

  • "Admission" : si ce scope est sélectionné la recherche de l'étudiant s'effectuera sur la population restreinte aux seuls admis (inscription non-définitive).
  • "Inscriptions en formation initiale"
  • "Inscription en formation continue"

Périmètre :

Cette api délivre les données des étudiants inscrits dans les établissements sous tutelle du ministère de l'enseignement supérieur.

La couverture des établissements du champ des étudiants sera progressivement complétée.

🔎 Consulter le nombre d'étudiants identifiés dans l'API

Statut étudiant boursier

Liste des données
DonnéeDescription
Statut boursierIndique si l'étudiant est boursier
Echelon de la bourseEchelon de la bourse de 0bis à 8
emailAdresse mail
Période de versement / Date de rentréeDate de début de rentrée scolaire ou universitaire et durée de versement de la bourse
Statut de la bourseStatut définitif ou provisoire (conditionnel)
Ville d'étudeLibellé de la ville d'étude

Précisions sur les données

Vous aurez à sélectionner des scopes de données dans votre demande. Voici leur fonctionnement :

Deux scopes sont utilisés comme "masque de données". Ces données ne seront donc pas retournées si le scope n'a pas été sélectionné.

  • "Etablissements" : renvoie le ou les établissements et code COG du lieu d'étude
  • "INE (Identifiant National Etudiant)"

Trois scopes ont été réalisés pour ne travailler que sur une population restreinte

  • "Admission" : si ce scope est sélectionné la recherche de l'étudiant s'effectuera sur la population restreinte aux seuls admis (inscription non-définitive).
  • "Inscriptions en formation initiale"
  • "Inscription en formation continue"

Périmètre : L’API délivre les données des étudiants :

  • Boursiers d’État sur critères sociaux (gérés par les Crous) ;
  • Boursiers sur critères sociaux des filières sanitaires et sociales des régions.

Liste des régions dont les données sont disponibles dans l'API

⚠️ La liste des boursiers gérés par les régions, disponible dans cette API, sera mise à jour dès mise à disposition des informations. L’API à ce jour, couvre uniquement le périmètre des boursiers sur critères sociaux à l’exception des boursiers Campus France et des autres bourses.

Régions disponibles

  • Normandie

Statut demandeur d'emploi

Liste des données
DonnéeDescription
IdentitéNom, prénom, civilité, date de naissance
Données de contacte-mail, téléphone
Adresse
InscriptionDate d’inscription, date de cessation inscription, catégorie d’inscription

Précisions sur les données

Sont disponibles les données des demandeurs d’emploi inscrits ou ayant été inscrits à Pôle emploi depuis 2010, date d’inscription et de cessation d’inscription le cas échéant.

Les catégories de situation des demandeurs d’emploi sont les 5 proposées par Pôle emploi: A, B, C, D et E. La répartition permet d'établir une classification selon la disponibilité du demandeur d'emploi.

  • A : Personne sans emploi, tenue d'accomplir des actes positifs de recherche d'emploi, à la recherche d'un emploi quel que soit le type de contrat (CDI,CDD, à temps plein, à temps partiel, temporaire ou saisonnier)
  • B : Personne ayant exercé une activité réduite de 78 heures maximum par mois, tenue d'accomplir des actes positifs de recherche d'emploi
  • C : Personne ayant exercé une activité réduite de plus de 78 heures par mois, tenue d'accomplir des actes positifs de recherche d'emploi
  • D : Personne sans emploi, qui n'est pas immédiatement disponible, et qui n'est pas tenue d'accomplir des actes positifs de recherche d'emploi (demandeur d'emploi en formation, en maladie, etc.)
  • E : Personne pourvue d'un emploi, et qui n'est pas tenue d'accomplir des actes positifs de recherche d'emploi

L’Adresse est celle déclarée par le demandeur lors de son inscription ou suite à une déclaration de changement d’adresse. L’API devrait inclure d’ici fin 2021 des données relatives à l’indemnisation des demandeurs d’emploi.

Les conditions générales d'utilisation sont disponibles à cette adresse.

Chaque année, l'équipe de l'API Particulier envoie un bilan chiffré sur l'utilisation de l'API, et la feuille de route de l'année suivante (nouvelles démarches, prochaines données qui intègrent l'API...).

👋
Est-ce que cette page vous a été utile ?

Accéder aux données

L’API nécessite une habilitation :

Documentation technique

Vous êtes développeur ou architecte ? Partagez la documentation avec votre équipe :

L’API en détail

Disponibilité : 99.99% sur le dernier mois
Limite : 20 appels / seconde / jeton