Consulter une connexion

L'API consulter une connexion permet aux utilisateurs de l'OD de récupérer toutes les données d'une connexion

Pré-requis

• Posséder un compte OD

Requête

Pour consulter une connexion on fait une requête GET sur le chemin d'accès suivant:

v1/connexions/<identifiant connexion>

On doit passer:

• L'identifiant utilisateur de l'OD dans l'en-tête X-OD-User-ID
• L'identifiant de la connexion dans l'URL

Par exemple:

cURL

Requête de consultation d'une connexion

curl \
-H 'X-OD-User-ID: ${userId}' \
http://<host>:<port>/v1/connexions/5f9242fd-00eb-408d-b0c2-1df10148d6c7

Typescript

Requête de consultation d'une connexion

const url = 'http://<host>:<port>/v1/connexions/5f9242fd-00eb-408d-b0c2-1df10148d6c7'
const response: AxiosResponse = await axios.get(url, {
    headers: {
        'X-OD-User-ID': userId,
    }
});

Réponse

Si tout s'est bien passé, la réponse de l'OD est de la forme suivante:

Résultat de la consultation d'une connexion

{
    "id": "5f9242fd-00eb-408d-b0c2-1df10148d6c7",
    "type": "PDP",
    "status": "PENDING",
    // --- seulement si PENDING, AWAITING_VERIFICATION, ou OUTDATED ---
    "signupUrl": "http://...",
    "loginUrl": "http://...",
    // ----------------------------------------------------------------
    "entreprises": [
        {
            "siren": "810319517",
            "nom": "Dougs",
            "regimesFiscaux": [
            {
                "regime": "NORMAL_MENSUEL",
                "dateEntreeEnVigueur": "2024-04-15"
            }
            // ... autres régimes fiscaux
            ]
        }
        // ... autres entreprises
    ]
}

Données connexion

Propriété	Valeur
id	Identifiant interne de la connexion dans l'OD
type	PDP | PPF
status	PENDING | CONNECTED | AWAITING_VERIFICATION | OUTDATED
signupUrl	URL de création de compte PDP
loginUrl	URL d'association de ce compte OD à un compte PDP existant
entreprises[i].siren	Numéro SIREN de l'entreprise
entreprises[i].nom	Nom de l'entreprise
entreprises[i].regimesFiscaux[j].regime	Régime fiscal de l'entreprise
entreprises[i].regimesFiscaux[j].dateEntreeEnVigueur	Date d'entrée en vigueur du régime fiscal

Statut	Description
PENDING	La connexion est créée mais pas associée à ce compte OD
CONNECTED	La connexion est associée à ce compte OD
AWAITING_VERIFICATION	La connexion est associée à ce compte OD et en attente de la vérification d'identité de l'utilisateur
OUTDATED	La connexion est associée à ce compte OD mais le jeton d'accès à la PDP est périmé, l'utilisateur doit se reconnecter via l'URL loginUrl

Erreurs

Code	Message
400 Bad Request	Requête invalide - Voir messages d'erreur
401 Unauthorized	Informations d'authentification invalides
404 NotFound	La connexion n'a pas été trouvée