Quotient familial CAF & MSA
Quotient familial délivré par la CAF ou la MSA et composition de la famille de l'allocataire.
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 résidant en France
Actualisation de la donnée :
Cette API, opérée par la caisse nationale d’assurance vieillesse (CNAV), 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 données sont mises à jour :
- une fois par mois, après le premier week-end du mois, pour les allocataires CAF ;
- en temps réel lorsqu’il y a un changement de situation pour les allocataires MSA.
Le mois remonté est le mois en cours (M). Le calcul du quotient familial du mois M est basé sur les ressources du mois M-1.
💡 Pour les collectivités effectuant une mise à jour annuelle des ressources en janvier, les appels doivent donc être effectués en février car c’est en février que le calcul intègre les ressources de janvier.
Cas d'usages
Fiches pratiques et cas d'usages pour lesquels l'API est utile :
Spécifications de l'API
Format de l'information
Modalités d'appel
- Identité pivot
-
FranceConnect
Disponibilité
Limite d'appels
(partagé entre API du groupe)
Spécifications techniques :
Consulter le swagger Cas de tests (nouvelle fenêtre)Modalités d'appel
L’API est appelable avec l’identité de l’allocataire principal ou avec celle d’une personne composant son foyer (conjoint, enfants et autres ayants droit).
⚠️ Les enfants en garde partagée (résidence alternée) ne sont pas couverts : l’API ne peut pas être appelée avec leur identité.
Deux modalités d’appel sont possibles :
FranceConnect
Avec la modalité d’appel FranceConnect.
Identité pivot
- Nom de famille (nom de naissance)1, nom d'usage, prénoms3, sexe4, date de naissance de l'allocataire2, code COG du pays de naissance1 ;
- Commune de naissance (fortement recommandé) : peut être renseignée 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.
1 Obligatoire
2 Obligatoire pour l’option 2 du lieu de naissance.
3 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.
4 Fortement recommandé pour optimiser l’identification du particulier.
Les données
Cette API délivre les données suivantes du mois en cours :
- la composition familiale du particulier : données d’identité de l’allocataire, du conjoint et des enfants ;
- le quotient familial CAF ou MSA du particulier.
- l’adresse du particulier au format de La Poste. ⚠️ Cette adresse est déclarative. Si l’usager a changé d’adresse et n’a pas actualisé son adresse auprès de la CAF ou de la MSA, l’information sera donc obsolète.
Pour les allocataires CAF, un historique du QF :
Spécifiquement pour les allocataires CAF, le quotient familial des 23 mois précédents est disponible en précisant le mois et l’année dans l’appel. Une période plus ancienne est refusée par API Particulier en erreur 422 (code 00355), sans appel au fournisseur. La valeur du QF peut varier au cours du temps suite à un recalcul. ⚠️ Il n’y a pas d’historique de la composition familiale. La liste des membres de la famille est toujours celle du mois en cours.
Définition du quotient familial transmis:
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 404 “Dossier allocataire absent” est transmise par l’API.
Informations renvoyées en JSON :
Pour la MSA, le quotient familial est systématiquement recalculé ; l'année correspond donc toujours à l'année courante.
Pour la MSA, le quotient familial est systématiquement recalculé ; le mois correspond donc toujours au mois en cours.
Les scopes
Les champs de la réponse signalés par une étiquette violette ne sont retournés que si votre jeton porte le scope correspondant. En savoir plus sur le mécanisme des scopes.
-
QF
(cnaf_quotient_familial) -
Identités allocataire et conjoint
(cnaf_allocataires) -
Identités enfants
(cnaf_enfants) -
Adresse du foyer
(cnaf_adresse)
Erreurs
Lorsque cette API ne peut pas retourner les informations demandées, elle renvoie un code erreur. Les erreurs communes à toutes les API (jeton, paramètres obligatoires, quotas) sont décrites dans la nomenclature des codes erreurs ; celles qui suivent sont celles que cet endpoint peut renvoyer, y compris les erreurs génériques de son fournisseur de données.
Cette liste est aussi servie au format JSON, sans jeton, sur https://particulier.api.gouv.fr/api/errors?operation_id=api_particulier_v3_cnav_quotient_familial_with_civility.
| Code | Signification |
|---|---|
00354 |
Entité non traitable
Le mois demandé est incorrect ou est dans le futur. |
00355 |
Entité non traitable
La période demandée est antérieure de plus de 23 mois. Le quotient familial n'est disponible que pour le mois en cours et les 23 mois précédents. |
00356 |
Entité non traitable
L'année demandée doit être l'année en cours (N), N-1 ou N-2. |
00363 |
Entité non traitable
La date de naissance n'est pas correctement formatté |
00365 |
Entité non traitable
Le lieu de naissance n'est pas correctement formaté |
00367 |
Entité non traitable
Le ou les prénoms sont manquants. |
00400 |
Entité non traitable
Le code pays INSEE n'est pas correctement formaté |
00405 |
Entité non traitable
Le request_id n'est pas correctement formaté : l'en-tête X-Request-Id, s'il est fourni, doit être un UUID v4 |
00420 |
Entité non traitable
Le nom de naissance est manquant |
00422 |
Entité non traitable
L'annee de naissance est manquante |
00427 |
Entité non traitable
Le sexe de l'état civil est manquant |
00428 |
Entité non traitable
Le code cog du département de naissance est manquant ou invalide |
35560 |
Identité non reconnue par le fournisseur de données
Les paramètres d'identité fournis ne correspondent à aucune personne connue du fournisseur de données. |
35561 |
Paramètres de civilité refusés par le fournisseur de données
Un ou plusieurs paramètres de civilité ont été refusés par le fournisseur de données. |
35565 |
Période refusée par le fournisseur de données
La période demandée n'est pas couverte par le fournisseur de données. |
| Code | Signification |
|---|---|
10003 |
Dossier allocataire absent MSA
Le dossier allocataire n'a pas été trouvé auprès de la MSA. |
23003 |
Dossier allocataire absent CNAF
Le dossier allocataire n'a pas été trouvé auprès de la CNAF. |
35003 |
Allocataire non référencé
L'allocataire n'est pas référencé auprès des caisses éligibles |
40003 |
Dossier allocataire absent RNCPS
Le dossier allocataire n'a pas été trouvé auprès du RNCPS. |
| Code | Signification |
|---|---|
35000 |
Erreur interne du fournisseur de données
La réponse retournée par le fournisseur de données est invalide et a été identifié comme étant une erreur interne. Si le problème persiste, consultez la page de status ou contactez nous sur le support. |
35001 |
Service non disponible
Service du fournisseur de données temporairement indisponible ou en maintenance. |
35004 |
Erreur de résolution DNS
Problème de résolution DNS de l'adresse du serveur |
35008 |
Erreur auprès du fournisseur de données : trop de requêtes
Erreur de fournisseur de donnée : Trop de requêtes effectuées, veuillez réessayer plus tard. |
35009 |
Erreur de connexion sécurisée (TLS) avec le fournisseur de données
La connexion sécurisée avec le fournisseur de données n'a pas pu être établie : certificat invalide ou expiré, ou échec de la négociation TLS. L'équipe technique a été notifiée de cette erreur pour investigation. |
35011 |
Erreur temporaire du fournisseur de données
Merci de réessayer dans quelques instants |
35999 |
Erreur inconnue du fournisseur de données
La réponse retournée par le fournisseur de données est invalide et inconnue de notre service. L'équipe technique a été notifiée de cette erreur pour investigation. |
| Code | Signification |
|---|---|
35020 |
Maintenance du fournisseur de données
Le fournisseur de données semble être en maintenance |
| Code | Signification |
|---|---|
35002 |
Intermédiaire hors-délai
Temps d’attente d’une réponse du fournisseur de données écoulé. |
Modalité FranceConnect
En appelant cet endpoint avec un jeton FranceConnect, les erreurs suivantes s'ajoutent aux précédentes.
| Code | Signification |
|---|---|
51564 |
Identité inexploitable renvoyée par le fournisseur de données
L'identité renvoyée par le fournisseur de données est incomplète ou invalide. |
| Code | Signification |
|---|---|
51000 |
Erreur interne du fournisseur de données
La réponse retournée par le fournisseur de données est invalide et a été identifié comme étant une erreur interne. Si le problème persiste, consultez la page de status ou contactez nous sur le support. |
51001 |
Service non disponible
Service du fournisseur de données temporairement indisponible ou en maintenance. |
51004 |
Erreur de résolution DNS
Problème de résolution DNS de l'adresse du serveur |
51008 |
Erreur auprès du fournisseur de données : trop de requêtes
Erreur de fournisseur de donnée : Trop de requêtes effectuées, veuillez réessayer plus tard. |
51009 |
Erreur de connexion sécurisée (TLS) avec le fournisseur de données
La connexion sécurisée avec le fournisseur de données n'a pas pu être établie : certificat invalide ou expiré, ou échec de la négociation TLS. L'équipe technique a été notifiée de cette erreur pour investigation. |
51011 |
Erreur temporaire du fournisseur de données
Merci de réessayer dans quelques instants |
51999 |
Erreur inconnue du fournisseur de données
La réponse retournée par le fournisseur de données est invalide et inconnue de notre service. L'équipe technique a été notifiée de cette erreur pour investigation. |
| Code | Signification |
|---|---|
51501 |
Accès non autorisé
Le jeton d'accès est mal formaté. |
51502 |
Accès non autorisé
Le jeton d'accès n'a pas été trouvé ou est expiré. |
51504 |
Accès non autorisé
Le jeton d'accès FranceConnect est manquant. Cet endpoint requiert un jeton d'accès FranceConnect transmis via l'en-tête Authorization: Bearer. |
| Code | Signification |
|---|---|
51020 |
Maintenance du fournisseur de données
Le fournisseur de données semble être en maintenance |
| Code | Signification |
|---|---|
51002 |
Intermédiaire hors-délai
Temps d’attente d’une réponse du fournisseur de données écoulé. |
Questions & réponses
Historique
Ce que change le passage à la V.3 d’API Particulier:
- Le passage à la V.3 n’a pas eu d’impact sur la donnée distribuée qui reste identique ;
- Tous les changements sont décrits dans la table de correspondance du guide migration
Documentations des anciennes API :
Plus d'informations sur la gestion de version API Particulier dans cette documentation.
Conditions d'utilisation des données
Ouverture de la donnée :
Conditions générales :
Cette API et l'utilisation de ses données sont soumises 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 ParticulierCas d'usages
Fiches pratiques et cas d'usages pour lesquels l'API est utile :
Spécifications de l'API
Format de l'information
Modalités d'appel
- Identité pivot
-
FranceConnect
Disponibilité
Limite d'appels
(partagé entre API du groupe)
