Identities (obsolete)

Identities represent identification information returned by the institution about the user who established a connection.

This feature is obsolete. Please refere to Account Ownerships.

API endpoints

Authentication: endpoints listed in this page require header authentication with a user token.

List identities

GET https://{domain}.biapi.pro/2.0/users/{userId}/identities

Path Parameters

Name	Type	Description
userId*	Integer or "me"	ID of the related user.

200: OK List of identities

Response body: IdentitiesList object

Get identity

GET https://{domain}.biapi.pro/2.0/users/{userId}/identities/{identityId}

Get a single identity by ID.

Path Parameters

Name	Type	Description
userId*	Integer or "me"	ID of the related user.
identityId*	Integer	ID of the identity.

200: OK Identity details

Response body: Identity object

Data model

IdentitiesList object

Property	Type	Description
identities	Array of Identity object	List of identities.

Identity object

Property	Type	Description
id	Integer	ID of the identity.
id_connection	Integer	ID of the connection the identity was fetched from.
id_user	Integer	ID of the user.
id_source	Integer	ID of the source the identity was fetched from.
first_name	String or null	First name of the user, null if not returned by the institution.
last_name	String or null	Last name of the user, null if not returned by the institution.
full_name	String or null	Full name of the user has it is returned by the institution, null if not returned by the institution.
last_update	DateTime	Date and time when the identity was last updated.
ibans	Array of strings	List of IBANs returned by the connection.