Quotient familial MSA & CAF Nouvelle version

Quotient familial et composition de la famille d'un allocataire du régime agricole (régime général à venir).

Logo du fournisseur de données
Fournisseur de la donnée

Cnaf & Msa


Périmètre

Particuliers concernés :

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

  • ✅ le régime agricole (MSA) ;
  • ✅ 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 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.

Périmètre géographique :

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

Actualisation de la donnée :

Les données sont mises à jour en temps réel, cette API opérée par la CNAV (Caisse nationale d’assurance vieillesse) est reliée au système d’information de la Caisse nationale des allocations familiales (CNAF) et à celui de la mutualité sociale agricole (MSA).

⚠️ Les informations obtenues sont représentatives de la situation connue par la CNAF et la MSA au moment de l’appel, il est donc possible qu’un quotient familial appelé pour un mois donné à un instant T, soit différent s’il est redemandé à un instant T+. En savoir plus.

Spécifications de l'API

Format de l'information

Donnée structurée JSON

Modalités d'appel

  • Identité pivot
  • FranceConnect Pictogramme fournisseurs de données regroupés
Détails des modalités

Disponibilité

Temps réel :
Page de statut des API
Disponible 24h/24 et 7j/7

Spécifications techniques :

Consulter le swagger Cas de tests

Modalités d'appel

L’API est uniquement appelable avec les informations de l’allocataire.
Il n’est pas possible d’interroger cette API avec les informations des ayants droit.


Deux modalités d’appel sont possibles :

Cette API est FranceConnectée FranceConnect

Avec la modalité d’appel FranceConnect.

Identité pivot

Avec les données d’identité :

  • Nom de naissance*, nom d’usage, prénoms1, sexe*, date de naissance de l’allocataire** ;
  • Lieu de naissance :
    • Si le lieu de naissance est en France, la commune de naissance est obligatoire, elle peut être saisie de deux façons différentes :
      • Option 1 : Code COG de la commune de naissance*. En savoir plus ;
      • Option 2 : Nom de la commune de naissance* et code du département de naissance*. Pour cette option, la date de naissance est obligatoire. En savoir plus.

      Pour chacune des deux options ci-dessus, le code COG de la France 99100* doit également être renseigné en paramètre d’appel. Vous n’avez pas besoin de le demander à l’usager, il peut être déduit de la commune de naissance.

    • Si le lieu de naissance est à l’étranger : code COG du pays de naissance*.

* Obligatoire | ** Obligatoire pour l’option 2 du lieu de naissance.
1 Fournir plusieurs prénoms permet de limiter les risques d’homonymie mais un seul prénom peut fonctionner. Attention, l’usager doit compléter chaque prénom dans un champ distinct.

⚠️ Message API Particulier du 04.06.2024 : Nous avons constaté que les appels effectués sans nom de naissance et avec le nom d’usage ne fonctionnent pas dans une très grande partie des cas. Après investigation auprès de la CNAV (opérateur de l’API source), API Particulier a donc décidé de passer le paramètre “Nom de naissance” en obligatoire.

Les données

Cette API délivre :

  • la composition familiale du particulier, en savoir plus ;
  • le quotient familial CAF ou MSA du particulier. Par défaut, le quotient familial du mois en cours est transmis. Le QF de l’allocataire est disponible pour les 24 mois précédents en précisant le mois et l’année dans l’appel.

Le quotient familial au sens de la CNAF ou de la MSA a une définition différente du quotient familial de l’administration fiscale, en savoir plus.

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 par l’API.

Si le particulier n’a plus d’allocations, son QF n’est pas renvoyé. Une erreur est transmise par l’API.

Informations renvoyées en JSON :

Informations sur les parents composant la famille
Cette propriété contient 1 ou plusieurs éléments ayant les spécifications suivantes :
Nom
ex: JACQUES
Nom de naissance de l'allocataire
Nom d'usage
ex: JACQUES
Nom d'usage de l'allocataire
Prénoms
ex: JEAN-PIERRE THOMAS
Prénoms de l'allocataire
Année de naissance
ex: 2000
Année de la date de naissance de l'allocataire. Peut-être vide si inconnue.
Mois de naissance
ex: 01
Mois de la date de naissance de l'allocataire. Peut-être vide si inconnu.
Jour de naissance
ex: 31
Jour de la date de naissance de l'allocataire. Peut-être vide si inconnu.
Sexe
ex: M
Sexe de l'allocataire
Informations sur les enfants composant la famille
Cette propriété contient 1 ou plusieurs éléments ayant les spécifications suivantes :
Nom de naissance
ex: JACQUES
Nom de naissance de l'enfant
Nom d'usage
ex: JACQUES
Nom d'usage de l'enfant
Prénoms
ex: JEAN-PIERRE THOMAS
Prénoms de l'enfant
Année de naissance
ex: 2000
Année de la date de naissance de l'enfant. Peut-être vide si inconnue.
Mois de naissance
ex: 01
Mois de la date de naissance de l'enfant. Peut-être vide si inconnu.
Jour de naissance
ex: 31
Jour de la date de naissance de l'enfant. Peut-être vide si inconnu.
Sexe
ex: M
Sexe de l'enfant
Adresse de la famille
Adresse au format de la poste
Identité du destinataire
ex: Monsieur JEAN JACQUES
Identité du destinataire : Civilité, titre ou qualité + nom et prénom
Complément d'information du destinataire ou point de remise
Complément d'information du point géographique
Complément d'information du point géographique.
Voie
ex: 1 RUE DE LA GARE
Numéro et libellé de la voie
Lieu-dit
Lieu-dit ou service particulier de distribution : poste restante, boîte postale
Code postal
ex: 75002
Code postal et localité de destination
Pays
ex: FRANCE
Pays
Quotient familial CAF ou MSA
ex: 1045
Valeur du quotient familial calculé par la CAF ou la MSA
Année effective du QF
ex: 2023
Année effective du quotient familial appelé.
- Si aucune année et aucun mois n'ont été renseignés en paramètres d'appel, le quotient familial retourné sera celui du mois de l'année en cours. - Si aucune année, ni aucun mois sont renseignés, l'appel est effectué par défaut avec l'année et le mois en cours. - Si aucune année n'a été renseignée, et que le mois est renseigné, le quotient familial retourné sera celui du mois spécifié pour l'année en cours. En revanche, si la date finalement composée avec cette règle s'avère dans le futur (mois postérieur au moins en cours), l'API renvoie un erreur 400.
Mois effectif du QF
ex: 6
Mois effectif du quotient familial.
- Si aucun mois n'est renseigné, le mois en cours est utilisé par défaut. - Si le mois renseigné est postérieur au mois en cours, et qu'il compose une date dans le futur avec l'année appelée, l'API renvoie une erreur 400.
- Si aucun mois n'a été renseigné mais que l'année a été spécifiée en paramètres d'appel, le quotient familial retourné sera celui du mois en cours pour l'année spécifiée.

Questions & réponses

Le quotient familial retourné par l’API est le quotient familial de la CAF ou de la MSA. 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 CAF/MSA est revu à chaque changement de situation familiale et/ou professionnelle.

Calcul du QF CAF/MSA : 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

Le quotient familial CAF ou MSA d’un même mois peut changer. Il est recalculé fréquemment au cours du temps par la CAF et la MSA. En effet, la situation de la personne peut évoluer : perte d’un emploi, évolution des ressources, arrivée d’un enfant, majorité d’un enfant, modification de la législation, évolution des allocations logement etc.
Cette variation apparaît notamment entre le quotient familial du mois en cours appelé en début de mois ou en fin de mois.

Deplus, la date du calcul du quotient familial diffère selon qu’il s’agit du quotient de la CAF ou de la MSA.

  • La CAF effectue une sauvegarde des quotients recalculés uniquement lorqu’un changement subvient du côté de l’allocataire.

    Par exemple, un appel le 28 juin 2023, du quotient du mois en cours (juin 2023) : La CAF renverra le QF qu’elle a en mémoire, par exemple calculé le 19 juin 2023.

  • La MSA effectue un recalcul du quotient familial à chaque appel de l’API.

    Par exemple, un appel le 28 juin 2023 du quotient familial du mois en cours (juin 2023) : la MSA recalculera le QF le 28 juin 2023.

La notion de « composition familiale » peut correspondre à différentes définitions dans les administrations qui n’y comptent pas les mêmes personnes. Par exemple, pour calculer l’impôt sur le revenu d’un foyer, le service des impôts s’intéresse à une composition familiale appelée « foyer fiscal », et dont la nature est différente de celle renvoyée par cette API.

La composition familiale renvoyée par cette API correspond à celle établie pour effectuer le calcul du quotient familial, et donc à celle déclarée par les allocataires à la CAF et à la MSA.
Dans cette composition familiale, les personnes suivantes sont comprises :

  • L’adulte allocataire de la CAF ou de la MSA ;
  • Son ou sa conjointe le cas échéant ;
  • le ou les enfants dont la responsabilité affective et éducative, les frais liés au logement, à la nourriture et à l’éducation, sont assumés par l’allocataire qui n’est pas obligé d’avoir un lien de parenté direct. Les enfants sont pris en compte dès la grossesse, jusqu’à 21 ans en métropole (22 dans les DROM) et sous les conditions détaillées dans ce guide de la Caf.

Cette notion d’enfant à charge est différente de celle retenue par l’administration fiscale : par exemple, un enfant peut être toujours rattaché fiscalement à ses parents, mais ne plus faire partie de la composition familiale au sens de la CAF ou de la MSA.
C’est le cas d’un enfant ayant quitté le foyer de ses parents et ayant ouvert son propre dossier d’allocataire pour bénéficier d’une aide (par exemple les APL ou le RSA), mais qui souhaite tout de même être rattaché à la déclaration fiscale de ses parents.
Cet enfant appartiendra au même foyer fiscal que ses parents au sens de l’administration fiscale, mais à une famille différente selon la CAF ou la MSA.

Pour chacune des personnes de cette « famille » au sens de la CAF ou de la MSA, cette API renvoie les informations suivantes :

  • Nom d’usage ;
  • Prénoms ;
  • Jour, mois et année de naissance ;
  • Sexe.

Lorsque l’API est appelée avec l’identité pivot, pour identifier correctement le particulier, le système d’information a besoin de récupérer le lieu de naissance du particulier.

  • Pour les particuliers nés en France: le code COG pays 99100 est obigatoire. La commune de naissance est également obligatoire et peut-être renseignée via deux options différentes :

  • Pour les particuliers nés à l’étranger: le code COG pays est obigatoire.

Le code COG du pays de naissance est obligatoire pour tous les appels. Pour simplifier le parcours des usagers, évitez de demander aux particuliers nés en France de saisir leur pays de naissance, puisque vous pouvez le paramétrer directement -code COG pays France 99100-, dès qu’un particuloer renseigne les informations de sa commune de naissance (forcément en France).

Historique

Ce que change cette API CNAF-MSA par rapport à l’API précédente de la CNAF :

  • Le périmètre des particuliers concernés s’élargit avec l’ajout des bénéficiaires de la MSA qui sont au régime agricole.
  • Les paramètres d’appel évoluent. Dans l’API précédente, l’usager devait renseigner son numéro d’allocataire et son code postal. Avec cette API l’usager renseigne ses données d’identité.

Documentations des anciennes API :

Conditions d'utilisation des données

Ouverture de la donnée :

Donnée protégée

Conditions générales :

Cette API et l’utilisation de ses données est soumise aux CGU générales d’API Particulier, dont voici les principaux éléments auxquels vous vous engagez :

  • ne demander que les données strictement nécessaires ;
  • ne pas utiliser votre jeton d’accès pour une démarche différente de celle indiquée lors de votre demande (le cas échéant le jeton sera révoqué) ;
  • présenter les données obtenues uniquement aux seuls agents habilités et à tracer l’accès de ces agents aux données ;
  • ne pas commercialiser les données reçues et à ne pas les communiquer à des tiers en dehors des cas prévus par la loi.
L’ensemble des conditions sont consultables et téléchargeables ci-dessous :

CGU API Particulier

Spécifications de l'API

Format de l'information

Donnée structurée JSON

Modalités d'appel

  • Identité pivot
  • FranceConnect Pictogramme fournisseurs de données regroupés
Détails des modalités

Disponibilité

Temps réel :
Page de statut des API
Disponible 24h/24 et 7j/7

Spécifications techniques :

Consulter le swagger Cas de tests