Statut allocation de rentrée scolaire (ARS)
Statut bénéficiaire de l'allocation de rentrée scolaire (ARS).
Fournisseur de la donnée
CNAF & MSA
Périmètre
Particuliers concernés :
✅ Le périmètre de l’API couvre les bénéficiaires de l’allocation de rentrée scolaire (ARS).
⚙️ Vérification en cours avec le fournisseur de données pour confirmer le périmètre exact.
Périmètre géographique :
- ✅ France Métropolitaine
- ✅ Départements d’Outre-mer
- ❌ Les collectivités d’Outre-mer, ayant un autre système de sécurité sociale, ne sont pas concernées par cette API.
Actualisation de la donnée :
Les données sont mises à jour en temps réel et issues du répertoire national commun de la protection sociale (RNCPS) opéré par la CNAV (Caisse nationale d’assurance vieillesse).
Spécifications de l'API
Format de l'information
Donnée structurée JSON
Modalités d'appel
- Identité pivot
-
FranceConnect
Disponibilité
Loading...
Disponible 24h/24 et 7j/7
Limite d'appels
20 requêtes / seconde
(partagé entre API du groupe)
(partagé entre API du groupe)
Spécifications techniques :
Consulter le swagger Cas de tests (nouvelle fenêtre)Modalités d'appel
Cette API propose deux modalités d’appel :
FranceConnect
Avec la modalité d’appel FranceConnect.
Identité pivot
Avec les données d’identité :
- Nom de famille (nom de naissance), nom d’usage, prénoms, sexe, date de naissance de l’allocataire, code COG du pays de naissance ;
- Commune de naissance (fortement recommandé).
Les données
Cette API indique si le particulier est bénéficiaire de l’allocation de rentrée scolaire, en précisant la date d’ouverture du droit.
Informations renvoyées en JSON :
Statut bénéficiaire de l'allocation de rentrée scolaire (ARS)
Indique si le particulier est bénéficiaire de l'allocation de rentrée scolaire au moment de l'appel.
- Si le statut est 'allocataire', cela signifie que le particulier est l'allocataire de l'ARS.
- Si le statut est 'ouvrant_droit', cela signifie que le particulier est ouvrant droit de l'ARS.
- Si le statut est 'non_beneficiaire', cela signifie que le particulier n'est pas concerné par l'ARS.
- Si le statut est 'allocataire', cela signifie que le particulier est l'allocataire de l'ARS.
- Si le statut est 'ouvrant_droit', cela signifie que le particulier est ouvrant droit de l'ARS.
- Si le statut est 'non_beneficiaire', cela signifie que le particulier n'est pas concerné par l'ARS.
Date d'ouverture du droit à l'ARS
ex:
2024-08-09
Date de début de droit à l'allocation de rentrée scolaire du particulier bénéficiaire.
Ce champ est null dans le cas où le particulier n'est pas bénéficiaire de l'ARS.
Ce champ est null dans le cas où le particulier n'est pas bénéficiaire de l'ARS.
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 de rentrée scolaire
(cnav_allocation_rentree_scolaire)
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_rentree_scolaire_with_civility.
| 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. |
| 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 |
|---|---|
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. |
| Code | Signification |
|---|---|
36020 |
Maintenance du fournisseur de données
Le fournisseur de données semble être en maintenance |
| 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.
| 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é. |
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 ParticulierSpécifications de l'API
Format de l'information
Donnée structurée JSON
Modalités d'appel
- Identité pivot
-
FranceConnect
Disponibilité
Loading...
Disponible 24h/24 et 7j/7
Limite d'appels
20 requêtes / seconde
(partagé entre API du groupe)
(partagé entre API du groupe)