API Particulier

Pour effectuer l'appel, deux paramètres sont à compléter :

Particuliers concernés :

Cette API concerne les allocataires de la majorité des régimes :

• ✅ le régime général ;
• ✅ les titulaires de l'éducation nationale,
• ✅ les retraités de la fonction publique d'État et des collectivités locales ;
• ✅ les régimes spéciaux suivants : Artiste auteur compositeur, France Télécom, Industries électriques et gazières, Marin du commerce et pêche, Mines (régime général), Poste, RATP, SNCF, Navigation intérieure en cas d'accord local et les pensions des autres régimes.

Ne sont pas concernés par cette API, les bénéficiaires des régimes suivants :

• ❌ le régime agricole, les bénéficiaires étant rattachés à la MSA, ce qui représente 1 à 2% des allocataires ;
• ❌ le régime des titulaires de l'Assemblée nationale et du Sénat ;
• ❌ le régime de la navigation intérieure sauf lorsqu'un accord local est passé, et que le régime est alors pris en compte par la CAF.

ℹ️ Le QF CNAF est calculé seulement pour les allocataires dont les ressources sont déclarées. En effet, pour calculer le quotient familial, la CNAF collecte tous les mois auprès de la DGFIP les ressources de l'individu (revenus salariés et non-salariés, du capital, rentes ...). Elle récupère le bilan en fin d'année. Sans la réception de ces ressources, le QF CNAF ne peut être calculé : une erreur est renvoyée.

ℹ️ Si le particulier n'a plus d'allocations, son QF n'est pas renvoyé. Une erreur sera transmise.

Périmètre géographique :

• ✅ Allocataires de France métropolitaine
• ✅ Allocataires DROM COM
• ✅ Allocataires de nationalité étrangère

Fréquence de mise à jour des données :

Les données sont mises à jour en temps réel, l'API étant directement relié au système d'information de la Caisse nationale des allocations familiales.

⚠️ Les informations obtenues sont représentatives de la situation connue par la CNAF et peuvent évoluer très fréquemment. Le Quotient familial CAF est recalculé tous les mois, il peut être rétroactif et dépend de la situation du particulier et de l'état du droit. Il peut donc y avoir des écarts, notamment si la situation de la personne évolue entre temps : perte d'un emploi, évolution des ressources, arrivée d'un enfant, majorité d'un enfant, modification de la législation etc. Depuis que les allocations logement sont contemporaines (transmises très régulièrement), le QF est amené à évoluer lui aussi très fréquemment.

⚠️ Les données de l’API ne permettent pas encore de calculer les tarifs en établissement d'accueil du jeune enfant (Eaje) (crèche, multi-accueil, halte-garderie…). Elles ne doivent donc pas être utilisées pour le calcul des participations familiales en Eaje.

Quelle différence entre le quotient familial de la CAF et le QF de l'administration fiscale ?

Le quotient familial retourné par l'API est le quotient familial de la CAF. Ce QF est différent de celui de l'administration fiscale car il prend en compte les prestations familiales. Contrairement au quotient familial DGFIP calculé au moment de la déclaration de revenu, le QF de la CAF est revu à chaque changement de situation familiale et/ou professionnelle.

Calcul du QF de la CAF : 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.

Source : Caf.fr

Qu'est-ce qu'un enfant au sens de la CNAF ?

La liste des enfants transmis par l'API correspond à la notion d'enfant à charge au sens de la législation familiale. Pour qu'un enfant soit considéré comme "à charge", l’allocataire doit assurer financièrement son entretien de manière effective et permanente et assumer à son égard la responsabilité affective et éducative. Il n'y a pas d'obligation de lien de parenté avec l’enfant.

Deux notions d’enfant à charge cohabitent :

• enfant à charge au sens des prestations familiales (Pf) : un enfant est reconnu à charge s’il est âgé d’un mois à moins de 20 ans quelle que soit sa situation, dès lors que son salaire net mensuel ne dépasse pas 55 % du Smic brut ;
• enfant à charge au sens de la législation familiale: en plus des enfants à charge au sens des Pf, sont également considérés à charge pour les aides au logement, les enfants âgés de moins de 21 ans en Métropole (22 ans dans les Dom), les enfants âgés de 20 à 25 ans pour le calcul du Rmi/Rsa, et dès le mois de leur naissance, les enfants bénéficiaires de l’allocation de base de la Paje.

Source : data.caf.fr

Pour appeler l'API statut étudiant, deux modes d'appel sont possibles :

Un mode d'appel avec l'état civil de l'étudiant :

Ou un mode d'appel avec l'identifiant national étudiant :
⚠️ Ce mode est exclusivement accessible aux services de la sphère éducative.

Particuliers concernés :

Cette API concerne les ✅ étudiants inscrits dans les établissements sous tutelle du ministère de l'enseignement supérieur, ou pré-inscrits au sens du CROUS.

Ne sont pas concernés :

• ❌ les établissements sous tutelle du ministère de l'agriculture ;
• ❌ les établissements sous tutelle du ministère de la culture ;
• ❌ les établissements du secondaire (BTS, classes préparatoires,...) ;
• ❌ les établissements privés.

ℹ️ La couverture des établissements du champ des étudiants sera progressivement complétée. Le MSER, fournisseur de la donnée, précise que l'ambition de cette API est bien de couvrir un nombre maximum d’étudiants, même à terme les étudiants dont les établissements sont sous tutelles autre que celle du Ministère l’Enseignement Supérieur et de la Recherche.

Les étudiants concernés sont ceux ayant au minimum une pré-inscription ou inscription dans l'année en cours quelque soit leur régime : étudiant en formation initiale, apprenti, stagiaire de la formation continue, contrat de professionnalisation...

⚠️ Tous les établissements ne délivrent pas les informations des étudiants pré-inscrits au sens du CNOUS, indiqués par le statut admis. Par conséquent si un étudiant est pré-inscrit au sens du CNOUS et que l'API ne vous renvoie pas d'information, il n'est pas possible de considérer de façon définitive que cet étudiant n'est pas pré-inscrit.

Périmètre géographique :

Le référentiel national du statut étudiant couvre une partie des établissements de ✅ métropole et les départements et régions d'outre-mer : Martinique, Guadeloupe, Guyane et Réunion.

Ne sont pas couverts :

• ❌ les collectivités d’outre-mer Mayotte, Polynésie française, Saint-Barthélemy, Saint-Martin, Saint-Pierre-et-Miquelon, Wallis-et-Futuna ;
• ❌ Les établissements français de l'étranger.

ℹ️ Le MSER, fournisseur de la donnée, précise que l'ambition de cette API est bien de couvrir tous les établissements situées en France métropolitaine et d’outre-mer, y compris les collectivités d’outre-mer. Les établissements français de l'étranger ne seront pas contre pas couverts.

Fréquence de mise à jour des données :

La mise à jour des informations est variable selon les établissements car tous les établissements ne procèdent pas de la même manière pour fournir les données de pré-inscription et d’inscription :

• Pour les grandes universités, le délai peut être en temps réel ;
• Pour les petits établissements, le délai est probablement plus long.

Des inscriptions peuvent avoir lieu toute l'année, et la transmission de ces informations par les établissements se fait elle aussi tout au long de l'année.

Choisir dès votre demande d'habilitation le périmètre des données transmises :

Lors de votre demande d'habilitation, vous allez déterminer le périmètre des données en interrogeant tout ou partie de la base des étudiants :

• les inscriptions en formation initiale (cocher "Inscriptions en formation initiale");
• et/ou les inscriptions en formation continue (cocher "Inscriptions en formation continue");
• et/ou les pré-inscriptions pour le CROUS (cocher "Pré-inscriptions CROUS").

Si vous cochez les trois cases, vous aurez donc accès à toute la base.

⚠️ Le périmètre choisi est définitif, pour élargir ou réduire le périmètre vous devrez demander un nouveau jeton.

Cette API délivre les informations de l'étudiant sur l'année en cours :

ℹ️ Le nombre d'inscriptions est techniquement de 10 au maximum.

Quelle différence entre formation continue, la reprise d'études et la formation initiale ?

La formation initiale correspond à un parcours d’études amorcé à l’école élémentaire et suivi sans interruption de plus d’un an. S'il y a interruption, il s’agit d'une reprise d’études.

La formation continue est, quant à elle, destinée aux salariés, employés ou demandeurs d’emploi. Elle a pour objectif de conforter, améliorer ou acquérir des connaissances professionnelles au-delà de la formation initiale. La distinction principale entre formation initiale et formation continue est le critère de conventionnement, spécifique à la formation continue et qui se traduit par la signature d’une convention ou d’un contrat de formation professionnelle entre la personne et l’établissement formateur tel qu’il est décrit dans les articles L.6353-1 à L. 6353-7 du Code du travail et l’article D. 714-62 du Code de l’éducation.

Pour appeler l'API statut étudiant boursier, deux modes d'appel sont possibles :

Un mode d'appel avec l'état civil de l'étudiant :

Un mode d'appel avec l'identifiant national étudiant : ⚠️ Ce mode est exclusivement accessible aux services de la sphère éducative.

Particuliers concernés :

Cette API délivre uniquement les bourses "obligatoires", elle ne concerne pas les bourses d'ordre facultatif. Le périmètre n'est pas exhaustif à ce jour.

L'API délivre les données :

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

Périmètre géographique :

Uniquement les informations des boursiers de nationalité française. L'API couvre :

• le ✅ territoire français, dont les ✅ DROM ;
• ❌ Les territoires d'outre-mer ne sont pas couverts ;
• ❌ Les données des étudiants boursiers étrangers ne sont pas couvertes.

Pour les boursiers sur critères sociaux des filières sanitaires et sociales, d'autres régions devraient être couvertes à l'avenir.

Fréquence de mise à jour des données :

Les données sont mises à jour une fois par an, début septembre, une fois tous les étudiants inscrits.

Particuliers concernés :

L’API délivre des informations sur les ✅ personnes inscrites comme demandeur d’emploi.

Cela signifie que l'API transmet des informations sur les demandeurs d'emploi :

• en recherche d'emploi ;
• qui ne sont pas disponibles immédiatement ;
• qui ne sont pas tenus de faire des actes positifs de recherche d’emploi.

L'API renvoie la catégorie du demandeur d'emploi permettant justement de déterminer la situation précise du demandeur.

ℹ️ L'API délivre des informations sur les demandeurs d'emploi ayant été inscrits à Pôle emploi depuis 2010, y compris ceux dont l'inscription a pris fin. Dans ce cas, seules les dates d'inscription et de cessation d'inscription sont renvoyées. Actuellement, la durée de conservation de ces données (durée prévues à l’article R. 5312-44 du code du travail relatif au système d’information de Pôle emploi) va être amenée à changer, suite à la mise en œuvre du droit à l’oubli, travaux en cours.

Périmètre géographique :

Tous les demandeurs d'emploi sont concernés :

• ✅ France métropolitaine
• ✅ DROM COM
• ✅ Travailleurs étrangers ressortissant d'un européen (membre de l’Union Européenne, de l’Espace économique européen, de la Suisse, Monaco, Andorre ou Saint- Martin) ou ayant les titres et autorisations nécessaires pour être inscrits à pôle emploi.

Fréquence de mise à jour des données :

Les données sont mises à jour en temps réel, l'API étant directement reliée au système d'information de Pôle emploi.

Les informations obtenues sont représentatives de la situation à date du demandeur d'emploi. Par exemple, la catégorie d'inscription, donnée qui peut évoluer au cours du temps, est mise à jour en temps réel également.

La catégorie du demandeur d'emploi délivrée par l'API correspond aux 5 premières catégories administratives définies par l’arrêté du 5 février 1992 portant application de l’article L. 5411-2 du Code du travail. Les différentes situations des demandeurs d’emploi sont les suivantes :

Pour mieux comprendre ce qu'est une API, consulter cette page.

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.

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.

1. 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/.

2. Une fenêtre de connexion (compte Datapass) s'ouvre. Renseignez les mêmes identifiants utilisés lors de votre demande d'habilitation.

3. 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.

4. Vous devez transmettre ce jeton à votre éditeur ? Ou à votre équipe technique ? Utilisez un moyen de transmission sécurisé (messagerie cryptée par exemple).