Aller au contenu

La recherche des comptes

GET
/comptes
curl --request GET \
--url 'https://example.com/comptes?rattachement_cle=EPG&cadre_legal=epargne-salariale&type=parts-epargnant&sous_type=epargnant&statut=en-preparation&page=1&taille=50' \
--header 'Authorization: Bearer <token>'

Le rattachement se cherche en couples clé / référence. L’entrée « épargnant » : rattachement_cle=EPG et rattachement_ref servent TOUS les comptes du porteur chez ce tenant, toutes entreprises confondues.

rattachement_cle
string
Allowed values: EPG ENT FDS SGP BNK ORG

La clé du rattachement cherché — EPG pour les comptes d’un épargnant, ENT pour ceux rattachés à une entreprise, et ainsi de suite.

rattachement_ref
string
>= 1 characters

La référence du rattachement — un identifiant publié. Avec la clé EPG, l’entrée « épargnant » : tous les comptes du porteur.

origine_ref
string
>= 1 characters

L’identifiant publié de l’entreprise d’origine des avoirs (comptes de parts d’épargnant) — avec le rattachement d’un épargnant, l’entrée « salarié » (le couple).

dispositif
string
>= 1 characters

L’identifiant publié d’un dispositif : seuls les comptes portant des lots vivants de ce dispositif sont servis.

cadre_legal
string
Allowed values: epargne-salariale plan-epargne-retraite
type
string
Allowed values: parts-epargnant especes titres mixte droits-contractuels
sous_type
string
Allowed values: epargnant entreprise fonds societe-de-gestion banque organisme erreurs
statut
string
Allowed values: en-preparation ouvert suspendu en-cloture clos abandonne
page
integer
default: 1 >= 1
taille
integer
default: 50 >= 1 <= 200

La page demandée — vide si aucun compte ne répond (une recherche vide n’est pas une erreur).

Media typeapplication/json
object
lignes
required
Array<object>
object
compte
required

L’identifiant public du compte.

string
libelle
required
string
compte_general

Le numéro du compte général du plan.

string
type
required

Le type, tenu du compte général — ce que le compte enregistre.

string
Allowed values: parts-epargnant especes titres mixte droits-contractuels
sous_type
required

Le sous-type, tenu du compte général — l’entité que le compte reflète.

string
Allowed values: epargnant entreprise fonds societe-de-gestion banque organisme erreurs
cadre_legal

Le cadre légal, dérivé du compte général — absent pour un compte hors cadre (banque, organisme, erreurs).

string
Allowed values: epargne-salariale plan-epargne-retraite
statut
required
string
Allowed values: en-preparation ouvert suspendu en-cloture clos abandonne
rattachement_cle

La clé du rattachement — l’entité dont le compte porte les avoirs ou qu’il reflète ; absente pour un poste sans entité propre (suspens, collectif).

string
Allowed values: EPG ENT FDS SGP BNK ORG
rattachement_ref

La référence du rattachement — un identifiant publié, immuable.

string
origine_cle

La clé du second couple — comptes de parts d’épargnant seulement.

string
Allowed values: ENT
origine_ref

L’entreprise d’origine des avoirs, immuable.

string
justification_separation

Le motif documenté d’un compte supplémentaire dans le même cadre légal ; absent pour un compte unique.

string
dispositifs_presents

Les identifiants publiés des dispositifs portés par des lots vivants du compte — ce qui explique pourquoi le compte répond à un filtre dispositif. Vide pour un compte jamais alimenté.

Array<string>
total
required

Le nombre total de comptes du filtre — null quand on ne sait pas compter à coût raisonnable.

integer | null
Example
{
"lignes": [
{
"type": "parts-epargnant",
"sous_type": "epargnant",
"cadre_legal": "epargne-salariale",
"statut": "en-preparation",
"rattachement_cle": "EPG",
"origine_cle": "ENT"
}
]
}

Aucune entrée discriminante — ni référence de rattachement, ni entreprise d’origine.

Aucune identité présentée.

L’identité présentée n’a pas la famille tenue-de-compte:consultation.