Account Ownerships

We provide a view to the account ownerships of a user with Check.

This feature is not activated by default on your domain. Please contact us to request access.

API endpoints

List account ownerships

GET https://{domain}.biapi.pro/2.0/users/{user_id}/account_ownerships

List all account ownerships available in the API.

Path Parameters

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

200: OK List of account ownerships

Response body: AccountOwnership object

Data model

AccountOwnership object

Property	Type	Description
id_account	Integer	ID of the related bank account.
id_connection	Integer	ID of the related connection.
id_user	Integer	ID of the related user.
id_connector_source	Integer	Id of the related connector source.
name	String or null	The name of the bank account.
bank_name	String or null	The name of the bank.
multiple_holders	Boolean or null	Whether this account has multiple holders. It is null if it is not possible to determine it.
calculated	Array	List the properties of account ownerships which are calculated. The array is either empty or with the multiple_holders value when this property is calculated.
usage	BankAccountUsage values	Usage of the bank account.
parties	Array of AccountParty object	List of account parties.
identifications	Array of AccountIdentifications object	List of account identifications.

AccountParty object

Property	Type	Description
role	AccountPartyRole values	Role of the party.
identity	IdentityParty object	Identity of the party.

IdentityParty object

Value	Type	Description
is_user	Boolean or null	Whether this account party represents the PSU, holder of the connection. It is null when it is not possible to verify this relation.
full_name	String	Full name of the account party.

AccountIdentifications object

Property	Type	Description
scheme_name	AccountSchemeName	Name of the account scheme type.
identification	String	Identification number of the account.

AccountPartyRole values

Value	Description
holder	Entity which is the holder of the account.
co_holder	Entity which shares with others the holding of the account.
attorney	Generic case of a person having a mandate to access the account data.
custodian_for_minor	Entity that holds shares/units on behalf of a legal minor.
legal_guardian	Entity that was appointed by a legal authority to act on behalf of a person judged to be incapacitated.
nominee	Entity named by the beneficial owner to act on its behalf.
successor_on_death	Deceased's estate, or successor.
trustee	Legal owner of the property.
unknown	Unknown party.

Webhook

Account Ownerships found

An ACCOUNT_OWNERSHIPS_FOUND webhook is emitted during a sync after a bank ownerships have been synchronized.

Webhook request:

Property	Type	Description
account_ownerships	AccountOwnership object	The account ownerships related to the sync.