v1

latestOpenAPI 3.1.02026-07-2478315484.9 KB

Entities

Get Entity by ID

Returns a single Entity.

An Entity is generated whenever a Customer connects a new bank using the .connect() method in the LinkSDK with any data related permissions.

get/customers/v1/{customer_id}/entities/{entity_id}

customer_idstring uuid required

entity_idstring uuid required

idstring uuid required

The entity_id

customer_idstring uuid required

Identifies which Customer owns the connection

bank_identifierstring required

Identifies the bank which has been connected

bank_type'RETAIL' | 'SME' required

Specifies whether the Entity is a Retail or Corporate owned account.

created_atstring date-time required

When the entity was created