API Indemnisations v1

Présentation

L’API « Indemnisations » vous permet de savoir si un individu perçoit une prestation de l’assurance chômage (allocation d’aide au retour à l’emploi (ARE), allocation de sécurisation professionnelle (ASP)) de Pôle emploi ou s’il bénéficie des minima sociaux (AAH, AER, ASS, RSA).

A titre d’exemple, cela peut permettre à un individu de bénéficier d’aides liées à son type de ressource(s) ou d’allocation.

Cette API fait partie de l’ensemble des API mises à disposition dans le cadre de l’utilisation du dispositif de portabilité de Pôle emploi des données personnelles d'un individu.

Pour pouvoir l'exploiter, l'utilisateur doit au préalable s'être identifié sur l’application ou le site web avec son compte Pôle emploi grâce au bouton « Se connecter avec Pôle emploi » (API Se connecter avec Pôle emploi).

 

Caractéristiques

Mode d'accès

restreint (demande d'accès soumise à validation de Pôle emploi)

Fréquence de mise à jour

temps réél

Cinématique OAuth

authorization code flow

Royaume Pôle Emploi Access Management

/individu

Scopes nécessaires

 

Description de la requête

Point d'accès

GET https://api.emploi-store.fr/partenaire/peconnect-indemnisations/v1/indemnisation

 

Exemple d'appel

GET https://api.emploi-store.fr/partenaire/peconnect-indemnisations/v1/indemnisation

Authorization: Bearer [Access token]

 

Description de la réponse

Données retournées

Code Cardinalité Format Description
beneficiairePrestationSolidarite 1 Booléen

Indique si l'utilisateur connecté est bénéficiaire d’un ou de minima sociaux (ASS, AAH, RSA, AER)

beneficiaireAssuranceChomage 1 Booléen

Indique si l'utilisateur connecté est bénéficiaire de l’assurance chômage (ARE ou ASP)

 

Exemple de retour

HTTP 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control: no-store
Pragma: no-cache

{
    "beneficiairePrestationSolidarite": false,
    "beneficiaireAssuranceChomage": true
}

 

Cas d'erreurs possibles

Retrouvez la liste des cas d'erreurs possibles sur la page Erreurs Types.