Account Controls (New)1

Accounts Raw Data1

authentication1

Balance Raw Data1

Bank1

Behavioral Insights (New)1

Beneficiaries Raw Data1

Cashflow Patterns (New)1

Consents4

Consents Account On File1

Credit Assessments (New)1

Credit Obligations (New)1

Customer5

Data refresh1

Direct Debits Raw Data1

Entities4

Events1

Expenses1

Identity Raw Data1

Income1

International AVS1

Name Verification1

Payment Destination4

Payment Intents3

Payment Links6

Payment Source3

Payments1

Payments Account On File1

Payouts5

Pending & Asynchronous Requests1

Raw Data1

Reconciliation3

Refunds4

Report2

Scheduled Payments Raw Data1

Schedules9

Standing Orders Raw Data1

Transactions Raw Data1

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}

Path parameters

customer_idstring uuid required

entity_idstring uuid required

Response

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

Changes

No recorded changes to this endpoint across all 1 revision of this API.