Get Entity by ID

get https://sandbox.sa.leantech.me/customers/v1/{customer_id}/entities/{entity_id}

Response

Response body

object

string

The unique entity identifier

customer_id

string

The Customer object that owns the entity

bank_identifier

string

The identifier signifies which bank the user's entity is linked with.

permissions

object

List of permissions for this consent.

identity

boolean

Indicates access to read identity data

accounts

boolean

Indicates access to read accounts data

balance

boolean

Indicates access to read balance data

transactions

boolean

Indicates access to read transactions data

identities

boolean

Indicates access to read identities data. Only relevant in KSA.

scheduled_payments

boolean

Indicates access to read scheduled payments data. Only relevant in KSA.

standing_orders

boolean

Indicates access to read standing orders data. Only relevant in KSA.

direct_debits

boolean

Indicates access to read direct debits data. Only relevant in KSA.

beneficiaries

boolean

Indicates access to read beneficiares data. Only relevant in KSA.

bank_type

string

The bank type of the connected entity

RETAIL

consents

array of objects

Record of all historical consents. Note that only 1 consent can be ACTIVE at the same time

consents

object

string

Lean internal id for the consent.

bank_consent_id

string

Id provided by the bank for the consent.

consent_status

string

Status of the consent.

ACTIVE REVOKED REJECTED

creation_date_time

date-time

When the consent was created.

status_update_date_time

date-time

Last update for the consent.

expiration_date_time

date-time

When the consent is or will no longer be valid.

transaction_from_date_time

date-time

For consents that include a permission for transactions, the first date of the transactions you can request for.

transaction_to_date_time

date-time

For consents that include a permission for transactions, the last date of the transactions you can request for.

permissions

object

List of permissions for this consent.

accounts

array of objects

Accounts the end user has consented to share.

accounts

object

identification_type

string

Indicates the type of identification being provided.

Value	Description
IBAN	The `identification` field is returning the IBAN for the account.
MASKED_PAN	The `identification` field is returning a masked Primary Account Number (PAN) for a card attached to the account.

IBAN MASKED_PAN

identification

string

Returns a value based on the identification_type.

name

string

The account name is the name or names of the account owner(s) represented at an account level. Note: The account name is not the product name or the nickname of the account.

secondary_identification

string

Additional form of identification for the account

Headers

object

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sandbox.sa.leantech.me/customers/v1/customer_id/entities/entity_id \
3
     --header 'accept: application/json'


xxxxxxxxxx
48
}
1
{
2
  "id": "string",
3
  "customer_id": "string",
4
  "bank_identifier": "string",
5
  "permissions": {
6
    "identity": true,
7
    "accounts": true,
8
    "balance": true,
9
    "transactions": true,
10
    "identities": true,
11
    "scheduled_payments": true,
12
    "standing_orders": true,
13
    "direct_debits": true,
14
    "beneficiaries": true
15
  },
16
  "bank_type": "RETAIL",
17
  "consents": [
18
    {
19
      "id": "string",
20
      "bank_consent_id": "string",
21
      "consent_status": "ACTIVE",
22
      "creation_date_time": "2025-03-16T14:17:42.582Z",
23
      "status_update_date_time": "2025-03-16T14:17:42.582Z",
24
      "expiration_date_time": "2025-03-16T14:17:42.582Z",
25
      "transaction_from_date_time": "2025-03-16T14:17:42.582Z",

200OK