API Particulier
Producteur : DINUMEntités administratives, simplifiez les démarches des particuliers en récupérant pour eux leurs informations administratives (quotient familial CAF, composition familiale, statut demandeur d’emploi, étudiant et étudiant boursier)
Description
API Particulier permet aux entités administratives d'accéder aux données et aux documents administratifs des particuliers, afin de simplifier leurs démarches.
Ce bouquet de données provenant d'administrations différentes est utilisable :
- ✅ dans le cadre des démarches en ligne proposées aux usagers (formulaires en ligne ou téléservices) ;
- ✅ dans les logiciels métiers utilisés par les agents habilités en guichet.
- ❌ l'API particulier n'est pas encore France connectée, de fait, même si votre service intègre le bouton France Connect, les informations de vos usagers nécessaires à l'appel de l'API (comme par exemple le numéro d'allocataire ou la date de naissance) et détenues dans l'identifiant France connect, devront transiter dans vos systèmes.
À quoi sert l’API Particulier ?
En tant qu'administration ou collectivité, en intégrant la brique API Particulier dans votre système d’information ou votre site internet :
- Vous n’avez plus besoin de demander certains justificatifs aux particuliers ;
- Vous n’avez pas de vérification supplémentaire à réaliser car les informations sont certifiées ;
Vous accédez avec un seul compte aux données de différents fournisseurs : la Caisse nationale des allocations familiales (CNAF), Pôle-emploi, le ministère de l'enseignement supérieur et de la recherche (MESR) et enfin le Centre national des œuvres universitaires et scolaires (Cnous).
Ville de ClamartAurélie CoutantMaintenant 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.
C'est aussi plus simple pour vos usagers !
- Leur démarche est réalisable 100% en ligne autant qu'en guichet.
Ils n'ont plus besoin de rassembler et saisir les documents ou informations déjà connues de l'administration.
Ville de ClamartSimon-Pierre ChalvidanEn 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.
Exemples d’application
API accessibles depuis l'API Particulier
| API | Fournisseur des données | Données | Disponibilité sur API Particulier | |
|---|---|---|---|---|
| Quotient familial CAF | CNAF | Quotient familial CAF, composition familiale 📖 Documentation | ✅ | |
| Statut étudiant | MESR | Statut, établissement 📖 Documentation | ✅ | |
| Statut étudiant boursier | Cnous | Statut, niveau de bourse 📖 Documentation | ✅ | |
| Statut demandeur d'emploi | Pôle Emploi | Statut et catégorie (A,B,C,D) 📖 Documentation | ✅ | |
| Indemnités demandeur d'emploi | Pôle Emploi | / | Juin 2023 | En cours de test |
| Statut CSS | / | / | Juillet 2023 | |
| Statut RSA | / | / | Juillet 2023 | |
| Statut élève scolarisé | / | / | Fin 2023 |
⚠️ Les données fiscales des particuliers ne sont plus disponibles via l'API Particulier, produit opéré par la DINUM. Pour obtenir ces données (ex : le revenu fiscal de référence, les informations sur les déclarants et le nombre de parts du foyer fiscal), veuillez désormais interroger directement l'API dédiée à l'accès aux données fiscales des particuliers l'API Impôt particulier de la DGFiP. Cette API est aussi compatible avec France Connect.
L'API Particulier n'est pas France connectée. Certaines des données de l'API Particulier sont par contre disponibles en mode France connecté, en vous branchant à chaque API, une par une :
| API sur API Particulier | Alternatives France connectées |
|---|---|
| Quotient familial CAF - CNAF | Disponible fin 2023 |
| Statut étudiant - MESR | ✅ API Statut Étudiant |
| Statut étudiant boursier - Cnous | ✅ API Statut Étudiant boursier |
| Statut demandeur d'emploi - Pôle Emploi | En cours de test |
🔎 En savoir plus sur les API et les API France Connectées.
Quelles sont les étapes pour utiliser l'API Particulier ?
Je suis une collectivité ou une administration
- Je consulte les cas d’usage de l'API Particulier :
- Si j'ai un éditeur de logiciel, je consulte le tableau en bas du cas d'usage pour savoir si mon éditeur intègre déjà l’API Particulier.
- Sinon je contacte mon éditeur et je lui transmets le lien vers la documentation technique pour m'assurer qu'il peut intégrer l'API.
- Je clique sur le bouton "faire une demande d'habilitation", je crée mon compte DataPass ou je me connecte.
- Une fois sur la première page du formulaire d'accès à l'API Particulier, je complète l'encadré "Qui implémentera l'API ?" :
- Si j'ai un éditeur, je coche "Votre éditeur de logiciel" et je le sélectionne dans la liste déroulante s'il est disponible.
- Si je n'ai pas d'éditeur, je coche "Votre équipe de développeurs". Je clique sur "Suivant".
- À la page suivante, rubrique "Modèles pré-remplis", je sélectionne le formulaire pré-rempli adéquat :
- Si j'ai un éditeur, je retrouve son nom et le nom de la solution dans la liste déroulante.
- Si je n'ai pas d'éditeur, je laisse le mode par défaut "Demande libre".
- Je complète mon formulaire : informations sur le projet, données nécessaires, traitement des données, cadre juridique - dont délibération -, coordonnées de l'équipe dont responsable technique, délégué à la protection des données et responsable de traitement.
- Une fois ma demande instruite et validée par l'équipe API Particuliere, je reçois un e-mail m'indiquant où récupérer mon jeton. Je le transmets à mon éditeur ou à mes développeurs.
Je suis un éditeur et je ne suis pas encore référencé :
ℹ️ Si vous êtes éditeur de logiciels, c'est à votre client public, collectivité ou administration, de faire sa demande d'habilitation auprès de l'API Particulier.
Vous pouvez nous demander de vous référencer sur un cas d'usage afin de proposer un formulaire pré-rempli qui simplifiera l'expérience de vos clients. Voici la procédure à suivre :
- Je repère les données dont mes clients publics ont besoin pour un cas d'usage précis que je peux ou pourrai proposer dans ma solution logicielle ;
- Je consulte la documentation technique, et j'utilise le bac à sable pour tester les appels d'API ;
- J'écris à cette adresse pour être référencé sur le cas d'usage associé et avoir un formulaire pré-rempli à disposition de mes clients.
Détails sur les données
API Quotient familial CAF - CNAF
Paramètres d'appel à renseigner par l'utilisateur
| Donnée | Description |
|---|---|
| Numéro d'allocataire | |
| Code postal | Exemple : 84250 |
Liste des données
| Donnée | Description |
|---|---|
| Quotient familial CAF | Le quotient familial CAF du mois précédent pour la famille |
| Composition familiale | Liste des parents et des enfants de la famille (avec nom, prénoms, date de naissance). |
| Adresse | L'adresse structurée détenue par la CAF |
Précisions sur les données
Le quotient familial CAF 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 professionnelle. Il prend en compte le revenu imposable de l’année N-2 divisé par 12 + les prestations familiales du mois de référence, le tout divisé par le nombre de parts fiscales du foyer.
⚠️ Il faut distinguer le quotient familial de la CAF du QF fiscal, pour en savoir plus, consultez cet article de la CAF. Le quotient familial « DGFIP » est calculé au moment de la déclaration de revenus. Il divise le revenu imposable de l’année N-1 par le nombre de part fiscale du foyer.
API Statut étudiant - MESR
Paramètres d'appel à renseigner par l'utilisateur
Pour appeler l'API statut étudiant, deux modes d'appel sont possibles :
Un mode d'appel avec l'état civil de l'étudiant :
| Donnée | Description |
|---|---|
| Nom de l'étudiant | Nécessaire |
| Prénom | Nécessaire |
| Date de naissance | Nécessaire |
| Lieu de naissance | Facultatif |
Un mode d'appel avec l'identifiant national étudiant : ⚠️ Ce mode est exclusivement accessible aux services de la sphère éducative.
| Donnée | Description |
|---|---|
| Identifiant National Étudiant (INE) | Numéro à 11 caractères, par exemple 990000001HH |
Liste des données
| Donnée | Description |
|---|---|
| INE | Identifiant national de l'étudiant |
| Inscriptions en formation continue | Permet 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 initiale | Permet 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. |
| Admissions | Limite la recherche aux seuls étudiants admis (non-inscrits). |
| Etablissement | Le 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).
- "Inscription 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
API Statut étudiant boursier - Cnous
Paramètres d'appel à renseigner par l'utilisateur
Pour appeler l'API statut étudiant boursier, deux modes d'appel sont possibles :
Un mode d'appel avec l'état civil de l'étudiant :
| Donnée | Description |
|---|---|
| Nom de l'étudiant | Nécessaire |
| Prénom | Nécessaire |
| Date de naissance | Nécessaire |
| Lieu de naissance | Facultatif |
Un mode d'appel avec l'identifiant national étudiant : ⚠️ Ce mode est exclusivement accessible aux services de la sphère éducative.
| Donnée | Description |
|---|---|
| Identifiant National Étudiant (INE) | Numéro à 11 caractères, par exemple 990000001HH |
Liste des données
| Donnée | Description |
|---|---|
| Statut boursier | Indique si l'étudiant est boursier |
| Échelon de la bourse | Échelon de la bourse de 0bis à 8 |
| Adresse e-mail | |
| Période de versement / Date de rentrée | Date de début de rentrée scolaire ou universitaire et durée de versement de la bourse |
| Statut de la bourse | Statut définitif ou provisoire (conditionnel) |
| Ville d'étude | Libellé de la ville d'étude |
Précisions sur les données
Périmètre : L’API délivre les données des étudiants boursiers :
- 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
API Statut demandeur d'emploi - Pôle emploi
Paramètres à renseigner par l'utilisateur
| Donnée | Description |
|---|---|
| Nom d’utilisateur Pôle emploi | Choisi par le particulier lors de la création de son espace personnel en ligne. |
Liste des données
| Donnée | Description |
|---|---|
| Identité | Nom, prénom, civilité, date de naissance |
| Données de contact | e-mail, téléphone |
| Adresse | |
| Inscription | Date 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 suivantes :
| Catégorie | Description |
|---|---|
| 1 | Personnes sans emploi, immédiatement disponibles au sens de l'article R. 311-3-3 (article R.5411-9 du CT), tenues d'accomplir des actes positifs de recherche d'emploi, à la recherche d'un emploi à durée indéterminée à plein temps |
| 2 | Personnes sans emploi, immédiatement disponibles au sens de l'article R. 311-3-3 (article R.5411-9 du CT), tenues d'accomplir des actes positifs de recherche d'emploi, à la recherche d'un emploi à durée indéterminée à temps partiel |
| 3 | Personnes sans emploi, immédiatement disponibles au sens de l'article R. 311-3-3 (article R.5411-9 du CT), tenues d'accomplir des actes positifs de recherche d'emploi, à la recherche d'un emploi à durée déterminée temporaire ou saisonnier, y compris de très courte durée |
| 4 | Personnes sans emploi, non immédiatement disponibles, à la recherche d'un emploi |
| 5 | Personnes pourvues d'un emploi, à la recherche d'un autre emploi |
| 6 | Personnes non immédiatement disponibles au sens de l'article R. 311-3-3 (1°) (article R.5411-10 1°) du CT) à la recherche d'un autre emploi, à durée indéterminée à plein temps, tenues d'accomplir des actes positifs de recherche d'emploi |
| 7 | Personnes non immédiatement disponibles au sens de l'article R. 311-3-3 (1°) (article R.5411-10 1°) du CT) à la recherche d'un autre emploi, à durée indéterminée à temps partiel, tenues d'accomplir des actes positifs de recherche d'emploi |
| 8 | Personnes non immédiatement disponibles au sens de l'article R. 311-3-3 (1°) (article R.5411-10 1°) du CT) à la recherche d'un autre emploi, à durée déterminée, temporaire ou saisonnier, y compris de très courte durée, tenues 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.
Informations à saisir par l'utilisateur (secrets) : Nom d’utilisateur Pôle emploi choisi par le particulier lors de la création de son espace personnel en ligne.
Conditions générales d'utilisation
Les conditions générales d'utilisation sont disponibles à ici en PDF.
Infolettre API Particulier
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...).
FAQ
Qu'est-ce qu'une API ?
Pour mieux comprendre ce qu'est une API, consulter cette page.
Les API sur API Particulier sont-elles France connectées ?
L’API particulier n'est pas encore France connectée, de fait, même si votre service intègre le bouton France Connect, les informations de vos usagers nécessaires à l'appel de l'API (comme par exemple le numéro d'allocataire ou la date de naissance) et détenues dans l'identifiant France connect, devront transiter dans vos systèmes.
En revanche, certaines données présentes dans le bouquet API Particulier sont aussi accessibles par une version France connectée des API. Il vous faudra alors faire une demande d'accès auprès de ces API directement. La liste des alternatives France connectée est décrite plus haut, à cette rubrique.
🔎 En savoir plus sur les API France Connectées.
Comment tester l'API ? Un jeton d'accès est-il nécessaire pour accéder au bac à sable ?
Vous pouvez accéder au bac à sable afin de tester des appels d’API avec des données virtuelles. Aucune habilitation n’est nécessaire, un token est généré immédiatement.
Il est possible d'ajouter des données au bac à sable à travers la plateforme Airtable : Depuis le swagger, en cliquant sur le détail des données proposées par un fournisseur de données, vous pouvez cliquer sur la liste des données présentes en bac à sable. Sur AirTable vous pouvez ensuite éditer des données. Exemple ici avec les données bac à sable de l'API de la CNAF.
Comment récupérer mon jeton d'accès (token) une fois ma demande validée ?
Une fois votre demande d'habilitation validée, un e-mail vous est envoyé avec un lien vers mon.portail-test-staging.api.gouv.fr/.
Une fenêtre de connexion (compte Datapass) s'ouvre. Renseignez les mêmes identifiants utilisés lors de votre demande d'habilitation.
Sur votre espace mon.portail-test-staging.api.gouv.fr/, votre jeton est disponible et peut-être copié.
⚠️ Votre token vous est propre, il ne faut pas le diffuser. Vous ne devez jamais copier-coller un token dans un moteur de recherche ou dans un e-mail. L’usage de votre token se fait uniquement dans votre logiciel métier sécurisé utilisé pour réaliser vos appels.Vous devez transmettre ce jeton à votre éditeur ? Ou à votre équipe technique ? Utilisez un moyen de transmission sécurisé (messagerie cryptée par exemple).
L’équipe
Documentation technique
L’API en détail
Partenaires
- CNAF
- Pôle Emploi
- mesr