Relevés de situation

GET

/v1/epargnants/{epargnant}/documents

const url = 'https://passerelle.teneur.exemple/v1/epargnants/example/documents?type=RELEVE_DE_SITUATION&page=0&taille=50';
const options = {
  method: 'GET',
  headers: {'Correlation-Id': 'example', Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://passerelle.teneur.exemple/v1/epargnants/example/documents?type=RELEVE_DE_SITUATION&page=0&taille=50' \
  --header 'Authorization: Bearer <token>' \
  --header 'Correlation-Id: example'

Autorisations

jetonPartenaire

Paramètres

Paramètres (path)

epargnant

required

string

>= 1 characters

L’identifiant publié de l’épargnant chez ce teneur de compte. Il désigne la ressource ; il n’est jamais le sujet de l’autorisation.

Paramètres (header)

Correlation-Id

required

string

>= 1 characters <= 128 characters

L’identifiant que le teneur de compte donne à l’échange dans son journal. Obligatoire : notre trace dit qui a lu quoi, jamais pour qui, et ce champ est la seule jointure entre les deux journaux. Il est restitué dans la réponse.

Paramètres (query)

type

Le vocabulaire clos des documents servis à l’épargnant.

string

Allowed values: RELEVE_DE_SITUATION AVIS_D_OPERE DOCUMENT_D_INFORMATION_CLE REGLEMENT_DU_DISPOSITIF

Restreindre à un type ; absent, tous les types servis.

depuis

string format: date

Borne basse incluse, sur la date d’émission.

page

integer

L’ordre est fixé par un critère stable : une page suivante ne saute ni ne répète une ligne, même si des lignes naissent entre deux appels.

taille

integer

default: 50 >= 1 <= 200

Réponses

200

La page demandée, du plus récent au plus ancien.

application/json

object

lignes

required

Array<object>

object

document

required

string

type

required

Le vocabulaire clos des documents servis à l’épargnant.

string

Allowed values: RELEVE_DE_SITUATION AVIS_D_OPERE DOCUMENT_D_INFORMATION_CLE REGLEMENT_DU_DISPOSITIF

libelle

required

string

emis_le

required

string format: date

format

required

string

Allowed values: application/pdf

dispositif

string

total

required

Le nombre total de lignes du filtre — null quand il ne se compte pas à coût raisonnable. Un portail pagine sans total ; il ne le fabrique pas.

integer | null

Example

{
  "lignes": [
    {
      "type": "RELEVE_DE_SITUATION",
      "format": "application/pdf"
    }
  ]
}

Headers

Correlation-Id

string

>= 1 characters <= 128 characters

L’identifiant de corrélation reçu, restitué tel quel — la jointure entre le journal du teneur et le nôtre.

400

400 — la demande est mal formée ; le motif nomme le champ en cause.

application/json

object

code

required

Le code stable sur lequel un portail se branche — le motif, lui, est écrit pour être lu par une personne et peut changer sans rupture.

string

Allowed values: DEMANDE_MAL_FORMEE CHAMP_INVALIDE NON_AUTHENTIFIE HORS_PERIMETRE_SOUSCRIT RESSOURCE_INCONNUE REJEU_DIVERGENT ECRITURE_REFUSEE

motif

required

Le motif, qui nomme le champ ou l’identifiant en cause.

string

champ

Le champ en cause, quand l’erreur en désigne un.

string

correlation

L’identifiant de corrélation de l’appel — le même que l’en-tête restitué.

string

Example

{
  "code": "DEMANDE_MAL_FORMEE"
}

401

401 — aucune identité présentée, ou jeton invalide : signature, émetteur, dates, tenant, ou audience obtenue pour une autre surface. La réponse porte WWW-Authenticate: Bearer error="invalid_token".

application/json

object

code

required

Le code stable sur lequel un portail se branche — le motif, lui, est écrit pour être lu par une personne et peut changer sans rupture.

string

Allowed values: DEMANDE_MAL_FORMEE CHAMP_INVALIDE NON_AUTHENTIFIE HORS_PERIMETRE_SOUSCRIT RESSOURCE_INCONNUE REJEU_DIVERGENT ECRITURE_REFUSEE

motif

required

Le motif, qui nomme le champ ou l’identifiant en cause.

string

champ

Le champ en cause, quand l’erreur en désigne un.

string

correlation

L’identifiant de corrélation de l’appel — le même que l’en-tête restitué.

string

Example

{
  "code": "DEMANDE_MAL_FORMEE"
}

Headers

WWW-Authenticate

string

Le défi d’authentification, au format des jetons porteurs.

403

403 — le cas d’usage n’est pas dans le périmètre souscrit de ce client. La réponse ne dit jamais si la ressource existe.

application/json

object

code

required

Le code stable sur lequel un portail se branche — le motif, lui, est écrit pour être lu par une personne et peut changer sans rupture.

string

Allowed values: DEMANDE_MAL_FORMEE CHAMP_INVALIDE NON_AUTHENTIFIE HORS_PERIMETRE_SOUSCRIT RESSOURCE_INCONNUE REJEU_DIVERGENT ECRITURE_REFUSEE

motif

required

Le motif, qui nomme le champ ou l’identifiant en cause.

string

champ

Le champ en cause, quand l’erreur en désigne un.

string

correlation

L’identifiant de corrélation de l’appel — le même que l’en-tête restitué.

string

Example

{
  "code": "DEMANDE_MAL_FORMEE"
}

404

404 — inconnu de ce teneur de compte. Un épargnant, un dispositif ou une opération relevant d’un autre teneur est inexistant, jamais interdit : la muraille de Chine ne laisse pas fuir une existence.

application/json

object

code

required

Le code stable sur lequel un portail se branche — le motif, lui, est écrit pour être lu par une personne et peut changer sans rupture.

string

Allowed values: DEMANDE_MAL_FORMEE CHAMP_INVALIDE NON_AUTHENTIFIE HORS_PERIMETRE_SOUSCRIT RESSOURCE_INCONNUE REJEU_DIVERGENT ECRITURE_REFUSEE

motif

required

Le motif, qui nomme le champ ou l’identifiant en cause.

string

champ

Le champ en cause, quand l’erreur en désigne un.

string

correlation

L’identifiant de corrélation de l’appel — le même que l’en-tête restitué.

string

Example

{
  "code": "DEMANDE_MAL_FORMEE"
}