Lean Technologies

Lean Entities API

Entities represent a customer's authenticated connection to a single bank, returned after a successful LinkSDK consent. List entities for a customer, retrieve a single entity by ID, or query entities across a date range.

Lean Entities API is one of 11 APIs that Lean Technologies publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 machine-runnable capability that can be deployed as REST, MCP, or Agent Skill surfaces via Naftiko.

Tagged areas include Entities, Open Banking, and Consents. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and 1 Naftiko capability spec.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.leantech.me/reference/entities

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/lean-tech/refs/heads/main/openapi/lean-entities-api-openapi.yml

Other Resources

🔗
NaftikoCapability
https://raw.githubusercontent.com/api-evangelist/lean-tech/refs/heads/main/capabilities/entities-entities.yaml

OpenAPI Specification

lean-entities-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Lean Entities API
  description: >
    Entities represent a customer's authenticated connection to a single
    bank, returned after a successful LinkSDK consent. Each entity carries
    the permissions granted (accounts, transactions, identity, balance) and
    is the handle used in Data API calls.
  version: '1.0'
  contact:
    name: Lean Support
    url: https://help.leantech.me
servers:
  - url: https://api2.leantech.me
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Entities
paths:
  /customers/v1/{customer_id}/entities:
    get:
      summary: Lean Get Entities For Customer
      operationId: getEntitiesForCustomer
      tags: [Entities]
      parameters:
        - $ref: '#/components/parameters/CustomerId'
      responses:
        '200':
          description: Entities for customer
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Entity'
  /customers/v1/{customer_id}/entities/{entity_id}:
    get:
      summary: Lean Get Entity By Id
      operationId: getEntityById
      tags: [Entities]
      parameters:
        - $ref: '#/components/parameters/CustomerId'
        - name: entity_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Entity'
  /customers/v1/entities:
    get:
      summary: Lean Retrieve All Entities For Date Range
      operationId: retrieveEntitiesForDateRange
      tags: [Entities]
      parameters:
        - name: start_date
          in: query
          schema:
            type: string
            format: date
        - name: end_date
          in: query
          schema:
            type: string
            format: date
      responses:
        '200':
          description: Entities
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Entity'
components:
  parameters:
    CustomerId:
      name: customer_id
      in: path
      required: true
      schema:
        type: string
        format: uuid
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
  schemas:
    Entity:
      type: object
      properties:
        id:
          type: string
          format: uuid
        customer_id:
          type: string
          format: uuid
        bank_identifier:
          type: string
        permissions:
          type: array
          items:
            type: string
            enum:
              - accounts
              - balance
              - transactions
              - identity
              - direct_debits
              - standing_orders
              - scheduled_payments
              - beneficiaries
        created_at:
          type: string
          format: date-time