Paiements versés par France Travail
Ensemble des paiements versés par France Travail au particulier.
France Travail
Périmètre
Particuliers concernés :
L’API concerne les demandeurs d’emploi ayant été inscrits à France Travail depuis 2010, y compris ceux dont l’inscription a pris fin.
Toutes les catégories de demandeurs d’emploi sont concernées par l’API :
- ✅ en recherche d’emploi ;
- ✅ disponibles immédiatement ;
- ✅ non-tenus de faire des actes positifs de recherche d’emploi ;
- ✅ tenues d’accomplir des actes positifs de recherche d’emploi.
Périmètre géographique :
- ✅ France métropolitaine ;
- ✅ DROM COM ;
- ✅ travailleurs étrangers ressortissant d’un pays européen (membre de l’Union Européenne, de l’espace économique européen, de la Suisse, Monaco, Andorre ou Saint-Martin) ou ayant les titres et autorisations nécessaires pour être inscrit à France Travail.
Actualisation de la donnée :
Les données sont mises à jour en temps réel, l’API étant directement reliée au système d’information de France Travail.Les informations obtenues sont représentatives de la situation à date des paiements versés au demandeur d’emploi.
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é d'appel
- Identifiant France Travail
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 une seule modalité d’appel :
Identifiant
Avec l’identifiant du compte utilisateur France Travail : Cet identifiant est celui choisi par le particulier lors de la création de son espace personnel en ligne.
⚠️ Avant d’utiliser la donnée issue de l’API, il est indispensable de vérifier que l’identifiant FranceTravail, utilisé en paramètre d’appel, correspond à l’identité du particulier. Pour cela vous devez effectuer un appel sur l’API statut demandeur d’emploi : Consulter les CGU spécifiques.
La modalité d’appel FranceConnect n’est pas disponible pour l’API demandeur d’emploi sur API Particulier.
Vous pouvez utiliser l’API dédiée de France Travail ! Cette API, qui n’appartient pas au bouquet API Particulier, permet d’accéder à la liste des paiements versés avec FranceConnect. Il vous faudra faire une habilitiation spécifique.
Les données
Cette API délivre la liste des paiements France Travail du demandeur d’emploi. L’historique maximal est de 24 mois. Ces paiements sont datés et répartis en 3 catégories (allocations, aides et autres paiements).
Cas particuliers :
- Si l’API est appelée pour un demandeur d’emploi qui n’est plus inscrit, l’API renvoie uniquement la liste de paiements de sa dernière inscription.
- Comme sur le compte utilisateur du demandeur d’emploi, il peut arriver que pour un appel en fin de mois, un paiement soit visible en anticipation, avec une date le mois suivant.
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.
-
API paiements France Travail
(pole_emploi_paiements)
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_france_travail_indemnites_with_identifiant.
| Code | Signification |
|---|---|
00308 |
Entité non traitable
Le user_id n'est pas correctement formaté |
00380 |
Entité non traitable
L'identifiant est manquant |
| Code | Signification |
|---|---|
24003 |
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 |
|---|---|
24000 |
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. |
24001 |
Service non disponible
Service du fournisseur de données temporairement indisponible ou en maintenance. |
24004 |
Erreur de résolution DNS
Problème de résolution DNS de l'adresse du serveur |
24008 |
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. |
24009 |
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. |
24011 |
Erreur temporaire du fournisseur de données
Merci de réessayer dans quelques instants |
24999 |
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 |
|---|---|
24020 |
Maintenance du fournisseur de données
Le fournisseur de données semble être en maintenance |
| Code | Signification |
|---|---|
24002 |
Intermédiaire hors-délai
Temps d’attente d’une réponse du fournisseur de données écoulé. |
Questions & réponses
Les catégories de demandeur d’emploi délivrées par l’API correspondent aux 8 catégories administratives définies par l’arrêté du 5 février 1992 portant application de l’article L. 5411-2 du Code du travail :
| Catégorie administrative | Description | Catégorie présente dans l’API |
|---|---|---|
| 1 | Personnes sans emploi, immédiatement disponibles, tenues d’accomplir des actes positifs de recherche d’emploi, à la recherche d’un emploi à durée indéterminée à plein temps. | ✅ |
| 2 | Personnes sans emploi, immédiatement disponibles, tenues d’accomplir des actes positifs de recherche d’emploi, à la recherche d’un emploi à durée indéterminée à temps partiel. | ✅ |
| 3 | Personnes sans emploi, immédiatement disponibles, tenues d’accomplir des actes positifs de recherche d’emploi, à la recherche d’un emploi à durée déterminée temporaire ou saisonnier, y compris de très courte durée. | ✅ |
| 4 | Personnes sans emploi, non immédiatement disponibles, à la recherche d’un emploi. | ✅ |
| 5 | Personnes pourvues d’un emploi, à la recherche d’un autre emploi. | ✅ |
| 6 | Personnes non immédiatement disponibles à la recherche d’un autre emploi, à durée indéterminée à plein temps, tenues d’accomplir des actes positifs de recherche d’emploi. | ✅ |
| 7 | Personnes non immédiatement disponibles à la recherche d’un autre emploi, à durée indéterminée à temps partiel, tenues d’accomplir des actes positifs de recherche d’emploi. | ✅ |
| 8 | Personnes non immédiatement à la recherche d’un autre emploi, à durée déterminée, temporaire ou saisonnier, y compris de très courte durée, tenues d’accomplir des actes positifs de recherche d’emploi. | ✅ |
Historique
Ce que change le passage à la V.3 d’API Particulier:
- Suppression du champ “identifiant” car il s’agissait du paramètre d’appel saisi.
- 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 spécifiques à cette API :
Il est indispensable de recouper l’identifiant du compte utilisateur France Travail avec l’identité du particulier avant d’utiliser cette API.
En effet, cette API est appelable avec un seul paramètre d’appel, l’identifiant du compte utilisateur France Travail. Par conséquent, si vous n’avez pas pu établir que cet identifiant utilisé en appel correspond bien au particulier concerné, vous prenez le risque de lui transmettre les données d’un autre allocataire.
En utilisant cette API, vous vous engagez donc à recouper l’identifiant du compte utilisateur France Travail avec l’identité du particulier en faisant un appel en parallèle sur l’API statut demandeur d’emploi.
En effet, cette autre API permet d’accéder aux deux informations.À notre connaissance, l’identifiant du compte utilisateur est configuré par l’usager au moment de la création de son espace et n’est donc présent sur aucun document ou courriel qui permettrait à un agent de vérifier l’identité. L’appel à l’API statut demandeur d’emploi est donc indispensable pour vérifier l’identité.
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é d'appel
- Identifiant France Travail
Disponibilité
Limite d'appels
(partagé entre API du groupe)