API Coordonnées v1

Présentation

L’API Coordonnées permet de restituer l'adresse postale de l'utilisateur connecté à votre application.

L'utilisateur doit au préalable s'être identifié sur votre application avec son compte Pôle emploi grâce à l'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 données à J-1
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-coordonnees/v1/coordonnees

 

Exemple d'appel

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

Authorization: Bearer [Access token]

 

Description de la réponse

Données retournées

Code Cardinalité Format Description
adresse1 0,1 String 50

Adresse - Complément destinataire

adresse2 0,1 String 50

Adresse - Complément d'adresse

adresse3 0,1 String 50

Adresse - Complément de distribution

adresse4 0,1 String 50

Adresse - Voie

codePostal 0..1 String 5

Code postal de la commune

Référentiel : Commune

codeINSEE 0..1 String 5

Code INSEE de la commune

Référentiel : Commune

libelleCommune 0..1 String 100

Libellé de la commune

Référentiel : Commune

codePays 0..1 String 2

Code du pays

Référentiel : Pays

libellePays 0..1 String 100

Libellé du pays

Référentiel : Pays

 

Exemple de retour

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

{
  "adresse1": "Complément Destinataire",
  "adresse2": "Complément Adresse",
  "adresse3": "Complément Distribution",
  "adresse4": "Voie",
  "codePostal": "44000",
  "codeINSEE": "44109",
  "libelleCommune": "NANTES",
  "codePays": "FR",
  "libellePays": "FRANCE"
}

 

Cas d'erreurs possibles

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