Statut étudiant boursier Déprécié
Statut et échelon boursier d'un étudiant, délivrés par le Cnous.
CNOUS
Cette API est dépréciée
Cette API est une ancienne version, nous vous invitons à utiliser ces API les plus récentes :
Périmètre
Particuliers concernés :
Cette API délivre uniquement les bourses “obligatoires” et ne concerne pas les bourses d’ordre facultatif.
L’API délivre les données sur :
- ✅ 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 pour les régions adhérentes.
Périmètre géographique :
L’API couvre :
- ✅ pour les bourses d’État : la France hexagonale, la Corse, les DROM (sauf Mayotte), la Polynésie française et la Nouvelle-Calédonie ;
- ✅ pour les bourses des filières sanitaires et sociales : les régions Auvergne-Rhône-Alpe, Bourgogne-Franche-Comté, Bretagne, Grand Est, Ile-de-France, Normandie et Occitanie. D’autres régions devraient être couvertes à l’avenir.
Ne sont pas couverts par cette API :
- ❌ les données des étudiants ayant des bourses étrangères.
Actualisation de la donnée :
Les données sont mises à jour tout au long de l’année. Une bascule d’année s’effectue à la fin de l’année scolaire, les données concernant la rentrée suivante sont alors disponibles (et remplacent l’année en cours) à partir du mois de :
- mai pour les bourses régionales ;
- juillet pour les bourses nationales. La base contient environ 85% des boursiers en octobre et est considérée comme complète en fin novembre.
Spécifications de l'API
Format de l'information
Modalités d'appel
- Identité pivot
- INE
-
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
Cette API propose trois modalités d’appel :
FranceConnect
Avec la modalité d’appel FranceConnect.
Identifiant
Avec l’Identifiant National Étudiant (INE) : Cet identifiant unique figure notamment sur la carte étudiant.
Identité pivot
Avec les données d’identité : Nom, prénom, sexe, date de naissance et lieu de naissance de l’étudiant (exemple : Angers)*.
*Tous les champs sont facultatifs.
Les données
Cette API indique si un étudiant est boursier et permet de connaître le montant de la bourse perçue grâce à l’échelon et la durée de versement.
Uniquement pour les bourses sur critères sociaux des filières sanitaires et sociales, en région, il est indiqué si l’échelon de bourse est définitif ou provisoire.
Informations renvoyées en JSON :
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 boursier
(cnous_statut_boursier) -
Échelon de la bourse
(cnous_echelon_bourse) -
E-mail
(cnous_email) -
Période de versement
(cnous_periode_versement) -
Statut définitif de la bourse
(cnous_statut_bourse) -
Ville d'études et établissement
(cnous_ville_etudes) -
Identité du boursier
(cnous_identite) -
Identifiant National des Élèves
(cnous_ine)
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_cnous_etudiant_boursier_with_civility.
| Code | Signification |
|---|---|
00368 |
Entité non traitable
L'année de campagne (campaignYear) n'est pas correctement formatée: doit être une année sur 4 chiffres supérieure ou égale à 2021 |
00420 |
Entité non traitable
Le nom de naissance est manquant |
00421 |
Entité non traitable
Le(s) prenom(s) est manquant |
00422 |
Entité non traitable
L'annee de naissance est manquante |
00423 |
Entité non traitable
Le mois de naissance est manquant |
00424 |
Entité non traitable
Le jour de naissance est manquant |
00425 |
Entité non traitable
La date de naissance n'est pas valide |
26561 |
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. |
26562 |
Identifiant refusé par le fournisseur de données
L'identifiant fourni a été refusé par le fournisseur de données. |
| Code | Signification |
|---|---|
26003 |
Entité non trouvée
Le ou les paramètre(s) d'entrée n'existent pas, ne sont pas connus, ou ne comportent aucune information pour cet appel. Veuillez vérifier que votre recherche est couverte par le périmètre de l'API. |
| Code | Signification |
|---|---|
26000 |
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. |
26001 |
Service non disponible
Service du fournisseur de données temporairement indisponible ou en maintenance. |
26004 |
Erreur de résolution DNS
Problème de résolution DNS de l'adresse du serveur |
26008 |
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. |
26009 |
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. |
26011 |
Erreur temporaire du fournisseur de données
Merci de réessayer dans quelques instants |
26999 |
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 |
|---|---|
26015 |
Conflit
Plusieurs ressources correspondent aux critères |
| Code | Signification |
|---|---|
26020 |
Maintenance du fournisseur de données
Le fournisseur de données semble être en maintenance |
| Code | Signification |
|---|---|
26002 |
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é. |
Modalité INE
En appelant cet endpoint avec l'Identifiant National Étudiant (INE), les erreurs suivantes s'ajoutent aux précédentes.
| Code | Signification |
|---|---|
00360 |
Entité non traitable
Le numéro d'INE n'est pas correctement formatté |
Questions & réponses
Il existe huit échelons de bourses d’étudiant, de 0bis à 7. Chaque échelon de bourse indique le montant reçu par l’étudiant pour l’année scolaire.
Pour chaque échelon, il y a deux montants possibles, le premier correspond au montant versé pour 10 mois ; le second, plus élevé, équivaut à 12 mois. Il est versé aux étudiants bénéficiant du maintien de la bourse pendant les grandes vacances universitaires. Les taux sont fixés par arrêté, la page dédiée sur Service-public.fr détaille les montants et vous permettra de retrouver l’arrêté de l’année en cours.
Cette API vous permet de connaître le montant exact perçu par l’étudiant car elle délivre l’échelon de la bourse et la durée de versement en mois.
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 ;
- Les données d’identité ne sont plus renvoyées lorsque la modalité d’appel est FranceConnect ;
- 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 ParticulierSpécifications de l'API
Format de l'information
Modalités d'appel
- Identité pivot
- INE
-
FranceConnect
Disponibilité
Limite d'appels
(partagé entre API du groupe)