Aller au contenu

La fiche d'identité d'une personne

GET
/epargnants/{epargnant}
curl --request GET \
--url https://example.com/epargnants/example \
--header 'Authorization: Bearer <token>'
epargnant
required
string
>= 1 characters

L’identifiant publié de l’épargnant chez ce tenant — stable à vie.

La fiche d’identité.

Media typeapplication/json

L’identité d’usage d’une personne — jamais l’identité brute ni les identifiants déclaratifs (NIF, NIN), qui ne sont pas servis en consultation courante.

object
epargnant
required

L’identifiant publié, stable à vie.

string
>= 1 characters
nom_usage

Le nom d’usage — absent pour qui n’en déclare pas (l’état civil d’usage, pas le nom de naissance).

string
prenoms
required
string
>= 1 characters
statut_cycle
required

L’étape de vie : actif ; retraite (dérivée du passage à la retraite) ; decede — seul terminus. Une personne décédée reste servie : l’identifiant est stable à vie.

string
Allowed values: actif retraite decede
Example
{
"statut_cycle": "actif"
}

La demande est irrecevable — le motif nomme le champ en cause.

Media typeapplication/json
object
motif
required

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

string
Examplegenerated
{
"motif": "example"
}

Aucune identité présentée (l’exigence est du contrat, le mécanisme de l’assemblage).

L’identité présentée n’a pas la famille d’accès epargnant:consultation.

L’épargnant est inconnu de ce tenant — la muraille ne révèle jamais l’existence d’un épargnant d’un autre teneur de compte (INV-EP-12) : il est inexistant, pas interdit.

Media typeapplication/json
object
motif
required

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

string
Examplegenerated
{
"motif": "example"
}