Statut allocation d'éducation de l'enfant handicapé (AEEH) Version beta

Statut bénéficiaire de l'allocation d'éducation de l'enfant handicapé (AEEH).

Cette API est en bêta test

Elle est en production et fonctionnelle, mais susceptible de changer en fonction des retours des utilisateurs et du fournisseur de données.

Vous serez bien entendu informé des changements en amont le cas échéant. N'hésitez pas à contacter le support si vous avez des questions.

Logo de CNAF & MSA
Fournisseur de la donnée

CNAF & MSA

Périmètre

Particuliers concernés :

L’API couvre l’ensemble des foyers bénéficiaires de l’allocation d’éducation de l’enfant handicapé (AEEH) :

  • ✅ le régime agricole (MSA) ;
  • ✅ le régime général (CAF) ;
  • ✅ 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
  • ✅ Saint-Barthélémy
  • ✅ Allocataires de nationalité étrangère résidant en France, dont ceux disposant d’un numéro d’immatriculation en attente (NIA)

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 :

  • en temps réel pour les allocataires CAF et MSA : toute nouvelle décision AEEH enregistrée dans le système d’information est disponible immédiatement dans l’API.

Cas d'usages

Fiches pratiques et cas d'usages pour lesquels l'API est utile :

Spécifications de l'API

Format de l'information

Donnée structurée JSON

Modalités d'appel

  • Identité pivot
  • FranceConnect
Détails des modalités

Disponibilité

Loading...
 Page de statut des API (nouvelle fenêtre)
Disponible 24h/24 et 7j/7

Limite d'appels

20 requêtes / seconde
(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, à partir des informations de l’allocataire ou de l’ouvrant-droit, sont possibles :

Cette API est FranceConnectée FranceConnect

Avec la modalité d’appel FranceConnect*.

*La modalité d’appel FranceConnect n’est utilisable qu’à partir de 16 ans pour un ouvrant-droit.

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é) :
    • Si le lieu de naissance est en France, la commune de naissance 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.

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 à partir de l’identité d’un allocataire ou d’un ouvrant-droit :

  • le statut AEEH du particulier, à savoir s’il est allocataire, ouvrant-droit ou non bénéficiaire ;
  • le détail des prestations AEEH versées à l’assuré :
    • la date d’ouverture du droit ;
    • l’organisme de rattachement.

Informations renvoyées en JSON :

Aperçu d'un exemple de réponse JSON
Statut bénéficiaire de l'allocation d'éducation de l'enfant handicapé (AEEH)
cnav_allocation_enfant_handicape
Indique si le particulier est bénéficiaire de l'allocation d'éducation de l'enfant handicapé au moment de l'appel.

- Si le statut est 'allocataire', cela signifie que le particulier est l'allocataire de l'AEEH (qualité bénéficiaire 105). Cela concerne généralement le parent ou le tuteur légal de l'enfant handicapé.
- Si le statut est 'ouvrant_droit', cela signifie que le particulier est ouvrant droit de l'AEEH (qualité bénéficiaire 205). Cela concerne généralement l'enfant handicapé lui-même.
- Si le statut est 'non_beneficiaire', cela signifie que le particulier n'est pas concerné par l'AEEH.
Date d'ouverture du droit à l'AEEH
cnav_allocation_enfant_handicape ex: 1992-11-29
Date de début de droit à l'allocation enfant handicapé du particulier bénéficiaire.
Ce champs est null dans le cas où le particulier n'est pas bénéficiaire de l'AEEH.

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.

  • Statut Allocation enfant handicapé (cnav_allocation_enfant_handicape)

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

422 — Entité non traitable
Code Signification
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
36560 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.
36561 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.
404 — Non trouvé
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.
502 — Erreur du fournisseur de données
Code Signification
36000 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.
36001 Service non disponible
Service du fournisseur de données temporairement indisponible ou en maintenance.
36004 Erreur de résolution DNS
Problème de résolution DNS de l'adresse du serveur
36008 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.
36009 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.
36011 Erreur temporaire du fournisseur de données
Merci de réessayer dans quelques instants
36999 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.
503 — Service non disponible
Code Signification
36020 Maintenance du fournisseur de données
Le fournisseur de données semble être en maintenance
504 — Intermédiaire hors délai
Code Signification
36002 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.

422 — Entité non traitable
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.
502 — Erreur du fournisseur de données
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.
401 — Non autorisé
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.
503 — Service non disponible
Code Signification
51020 Maintenance du fournisseur de données
Le fournisseur de données semble être en maintenance
504 — Intermédiaire hors délai
Code Signification
51002 Intermédiaire hors-délai
Temps d’attente d’une réponse du fournisseur de données écoulé.

Questions & réponses

Pour bénéficier de l’AEEH, l’enfant doit remplir les conditions suivantes :

  • avoir moins de 20 ans ;
  • résider en France de façon stable et permanente ;
  • être à la charge du demandeur ;
  • présenter un taux d’incapacité d’au moins 80 %, ou compris entre 50 % et 79 % si l’enfant bénéficie d’un accompagnement, d’un dispositif de scolarisation adapté, ou de soins/rééducations préconisés par la CDAPH ;
  • ne pas percevoir de revenus professionnels supérieurs à 55 % du Smic mensuel brut ;
  • ne pas être accueilli en internat avec prise en charge intégrale des frais de séjour par l’Assurance maladie, l’État ou le département, sauf pour les périodes de retour au foyer.
    Plus d’informations

Cette allocation n’est pas soumise à condition de ressources des parents.

Pour l’AEEH :

  • l’ouvrant-droit est l’enfant au titre duquel le droit est ouvert ;
  • l’allocataire est la personne qui perçoit la prestation, généralement le parent ou représentant légal.

Les deux parents sont associés à un même compte lorsqu’ils sont mariés, pacsés ou concubins ET à partir de la déclaration de ce changement par l’allocataire, sur le site caf.fr ou sur l’application « Caf -Mon Compte ». Cette déclaration induit de loger au même domicile, exception faite du cas d’un conjoint vivant à l’étranger dont la vie maritale est tout de même enregistrée auprès de la CAF ou la MSA.
Les parents qui sont associés à un même compte, sont gérés par une seule caisse, la CAF ou la MSA. Le choix de la caisse de rattachement revient au couple. Toutefois, il y a quelques exceptions :

  • lorsqu’un couple est bénéficiaire du RSA avec un des membres du couple exploitant agricole ou aide familial, quelle que soit la situation du conjoint ou concubin, seule la MSA est compétente pour le RSA et les prestations familiales. Le couple sera donc affilié à la MSA ;
  • Si un des deux membres du couple relève de l’Assemblée nationale ou du Sénat, il doit être enregistré en tant que responsable dossier, afin d’éviter les doubles paiements.

L’enfant sera uniquement rattaché au parent qui en a la charge. Dans le cas d’une situation de résidence alternée, l’allocation apparaîtra uniquement sur le compte du parent qui bénéficie de toutes les prestations ou, si aucun des deux n’était allocataire avant la séparation, au premier qui en fait la demande. Les conditions pour bénéficier d’un complément AEEH doivent être remplies par l’allocataire qui a la charge de l’enfant. 

L’algorithme d’identification du fournisseur de données s’appuie sur l’ensemble des paramètres d’entrée, mais certains ont un poids plus important :

  • Nom de naissance ;
  • Année de naissance ;
  • Lieu de naissance.

Si ces trois informations sont correctement fournies, le particulier peut être identifié même si les autres paramètres comportent des erreurs. En revanche, si ces informations ne sont pas renseignées ou sont erronées, le risque de recevoir une réponse 404 (dossier allocataire absent) augmente significativement.

Il est donc fortement recommandé de renseigner le lieu de naissance afin de maximiser les chances d’identification du particulier.

Lorsque l’API est appelée avec l’identité pivot, le lieu de naissance est fortement recommandé pour identifier correctement le particulier.

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

  • Pour les particuliers nés à l’étranger: le code COG pays doit être renseigné.

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 particulier renseigne les informations de sa commune de naissance (forcément en France).

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 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 Particulier

Cas d'usages

Fiches pratiques et cas d'usages pour lesquels l'API est utile :

Spécifications de l'API

Format de l'information

Donnée structurée JSON

Modalités d'appel

  • Identité pivot
  • FranceConnect
Détails des modalités

Disponibilité

Loading...
 Page de statut des API (nouvelle fenêtre)
Disponible 24h/24 et 7j/7

Limite d'appels

20 requêtes / seconde
(partagé entre API du groupe)

Spécifications techniques :

Consulter le swagger Cas de tests (nouvelle fenêtre)