Lean v2.0 KSA

https://docs.leantech.me/v2.0-KSA/docs/
Admin
Lean v2.0 KSA is a financial API platform that enables businesses to access real-time financial...
Tokens:55,082
Snippets:194
Trust Score:8.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Getting Started with Lean Technologies KSA

Source: https://docs.leantech.me/v2.0-KSA/docs/introduction

This guide explains how to get started with Lean Technologies KSA, including account creation and recommended practices for business continuity.

```markdown
# Getting set up

## GENERAL

*   [Getting set up](https://docs.leantech.me/v2.0-KSA/docs/introduction)
*   [Authentication](https://docs.leantech.me/v2.0-KSA/docs/authentication)

## BANK DATA BASICS

*   [Complying with KSA OB Standards](https://docs.leantech.me/v2.0-KSA/docs/sama-requirements)
*   [Sandbox testing](https://docs.leantech.me/v2.0-KSA/docs/sandbox-testing)

## Getting Started

To use Lean and access real-time, accurate financial data, you need to create an account at <https://dev.sa.leantech.me>.

> ❗️
> ### 
> Recommended
> [](https://docs.leantech.me/v2.0-KSA/docs/introduction#recommended)
> For business continuity, we recommend you to create a new mailing group dedicated to Lean's integration (_i.e:openbanking@yourcompany.com_) and add all the relevant employees to this group. Then, developers/employees can be added/invited to your sandbox account via our Developer Portal's "**Team** " feature/section.
```

--------------------------------

### Lean SDK Version Setup

Source: https://docs.leantech.me/v2.0-KSA/docs/ios

Provides an example of setting up the Lean SDK with a specific version string, recommending the use of a fixed version for stability.

```swift
Lean.manager.setup(
    appToken: String,
    sandbox: true,
    version: "latest"
    )
```

--------------------------------

### LeanTech KSA v2.0 General Setup

Source: https://docs.leantech.me/v2.0-KSA/docs/creating-an-entity

Guides for initial setup and authentication with the LeanTech KSA v2.0 platform.

```APIDOC
## GENERAL
  * [Getting set up](https://docs.leantech.me/v2.0-KSA/docs/introduction)
  * [Authentication](https://docs.leantech.me/v2.0-KSA/docs/authentication)
```

--------------------------------

### Getting Started with Lean Technologies KSA

Source: https://docs.leantech.me/v2.0-KSA/docs/index

This guide explains how to get started with Lean Technologies KSA, including account creation and recommended practices for business continuity.

```markdown
# Getting set up

## GENERAL

*   [Getting set up](https://docs.leantech.me/v2.0-KSA/docs/introduction)
*   [Authentication](https://docs.leantech.me/v2.0-KSA/docs/authentication)

## BANK DATA BASICS

*   [Complying with KSA OB Standards](https://docs.leantech.me/v2.0-KSA/docs/sama-requirements)
*   [Sandbox testing](https://docs.leantech.me/v2.0-KSA/docs/sandbox-testing)

## Getting Started

To use Lean and access real-time, accurate financial data, you need to create an account at <https://dev.sa.leantech.me>.

> ❗️
> ### 
> Recommended
> [](https://docs.leantech.me/v2.0-KSA/docs/introduction#recommended)
> For business continuity, we recommend you to create a new mailing group dedicated to Lean's integration (_i.e:openbanking@yourcompany.com_) and add all the relevant employees to this group. Then, developers/employees can be added/invited to your sandbox account via our Developer Portal's "**Team** " feature/section.
```

--------------------------------

### Java mTLS Integration

Source: https://docs.leantech.me/v2.0-KSA/docs/how-to-set-up-mtls

Offers resources for integrating mTLS authentication in Java applications. The provided GitHub link contains example code and setup instructions.

```link
https://github.com/leantechnologies/integration-snippets/tree/master/mtls-examples/java
```

--------------------------------

### Initialize Lean SDK in SwiftUI

Source: https://docs.leantech.me/v2.0-KSA/docs/ios

Demonstrates how to initialize the Lean SDK within a SwiftUI application. This setup configures the application token and environment.

```swift
// YourApp.Swift

import SwiftUI
import LeanSDK

@main
class LeanTestAppApp: App {

    required init() {
        Lean.manager.setup(
            appToken: String,
            sandbox: true,
            version: "latest"
        )
    }

    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}
```

--------------------------------

### Ruby mTLS Example

Source: https://docs.leantech.me/v2.0-KSA/docs/how-to-set-up-mtls

Provides an example of making an mTLS request in Ruby using the Net::HTTP library. It shows how to configure SSL options with your certificate, private key, and the CA file for verification.

```ruby
require 'openssl'
require 'net/http'

options = {
  use_ssl: true,
  verify_mode: OpenSSL::SSL::VERIFY_PEER,
  cert: OpenSSL::X509::Certificate.new(File.read('cert.crt')),
  key: OpenSSL::PKey::RSA.new(File.read('key.pem')),
  ca_file: 'ca.pem'
}

uri = URI("https://api.sa.leantech.me/banks/v1")
req = Net::HTTP::Get.new(uri)
req["lean-app-token"] = "<LEAN_APP_TOKEN>"

res = Net::HTTP.start(uri.hostname, uri.port, options) {
  http.request(req)
}

puts res.body
```

--------------------------------

### LeanTech LinkSDK Integration

Source: https://docs.leantech.me/v2.0-KSA/docs/how-to-use-account-verification

Guides for integrating the LeanTech LinkSDK across different platforms. This includes setup instructions for Web, iOS, Android, and React Native, along with customization options and an explanation of LinkSDK statuses.

```APIDOC
APIDOC:
  LinkSDK Integration:
    Web:
      - Setup instructions for integrating LinkSDK into web applications.
    iOS:
      - Setup instructions for integrating LinkSDK into iOS applications.
    Android:
      - Setup instructions for integrating LinkSDK into Android applications.
    React Native:
      - Setup instructions for integrating LinkSDK into React Native applications.

  LinkSDK Customization:
    Description: Details on how to customize the appearance and behavior of the LinkSDK.

  LinkSDK Statuses:
    Description: Explanation of the various statuses that LinkSDK can return, aiding in error handling and user feedback.

  Create your own bank list:
    Description: Information on how to create and manage a custom list of banks within the LinkSDK.
```

--------------------------------

### Payment Source Created Webhook Example

Source: https://docs.leantech.me/v2.0-KSA/docs/getting-started-with-payouts

This JSON object represents a webhook notification received after a payment source has been successfully created and pre-authorized. It includes details about the payment source, customer, bank, and the event type.

```JSON
{
  "payload": {
    "id": "a5c6b1ca-2a1a-317f-9920-7e1bf42ad945",
    "customer_id": "d3fdefba-95cf-4522-83e6-998c8b809e66",
    "status": "ACTIVE",
    "bank_identifier": "ALINMA_SME_DC_SAU",
    "bank_name": "Alinma",
    "end_user_id": "93b89ff7-528e-46bc-9836-8d3746a2147f"
  },
  "type": "payment_source.created",
  "message": "A payment source was pre-authorized by your customer.",
  "timestamp": "2022-09-15T16:10:07.968233222Z",
  "event_id": "f0dbbcf6-d5cf-4303-9537-17db781e5b42"
}
```

--------------------------------

### Go mTLS Client Setup

Source: https://docs.leantech.me/v2.0-KSA/docs/how-to-set-up-mtls

Demonstrates how to configure a Go HTTP client to use mTLS authentication. It loads client certificates, CA certificates, and makes a GET request to a specified endpoint with an application token.

```Go
package main

import (
	"crypto/tls"
	"crypto/x509"
	"flag"
	"io/ioutil"
	"log"
	"net/http"
)

var (
	// cert file MUST be a concatenation of certificate provided by Lean AND the certificate chain!!!
	certFile = flag.String("cert", "cert.crt", "Your application certificate provided by Lean concatenated with cert chain")
	keyFile  = flag.String("key", "key.pem", "Your private key attached to application certificate")
	caFile   = flag.String("CA", "ca.pem", "Lean's public certificate chain")
)

func main() {
	flag.Parse()

	// Load client cert
	cert, err := tls.LoadX509KeyPair(*certFile, *keyFile)
	if err != nil {
		log.Fatal(err)
	}

	// Load CA cert
	caCert, err := ioutil.ReadFile(*caFile)
	if err != nil {
		log.Fatal(err)
	}

	caCertPool := x509.NewCertPool()

	caCertPool.AppendCertsFromPEM(caCert)

	// Setup HTTPS client
	lsConfig := &tls.Config{
		Certificates: []tls.Certificate{cert},
		RootCAs:      caCertPool,
	}
	lsConfig.BuildNameToCertificate()

transport := &http.Transport{TLSClientConfig: tlsConfig}
client := &http.Client{Transport: transport}

	// Please change the end point and app token as required.

	req, err := http.NewRequest("GET", "https://api.sa.leantech.me/banks/v1", nil)
	req.Header.Set("lean-app-token", "<LEAN_APP_TOKEN>")
	if err != nil {
		log.Fatal(err)
	}

	res, err := client.Do(req)
	if err != nil {
		log.Fatal(err)
	}

	contents, err := ioutil.ReadAll(res.Body)
	log.Print(string(contents))

}
```

--------------------------------

### Install Lean SDK via Swift Package Manager

Source: https://docs.leantech.me/v2.0-KSA/docs/ios

Instructions for adding the Lean SDK to your Xcode project using Swift Package Manager. This is the recommended method for integration.

```text
https://www.github.com/leantechnologies/link-sdk-ios-distribution
```

--------------------------------

### UIKit Initialization

Source: https://docs.leantech.me/v2.0-KSA/docs/ios

Shows how to initialize the Lean SDK within a `UIViewController` by calling `Lean.manager.setup` during `ViewDidLoad`.

```swift
// ViewController.swift

import UIKit
import LeanSDK

class ViewController: UIViewController {

    override func ViewDidLoad() {
        super.viewDidLoad()
        Lean.manager.setup(appToken: String, sandbox: true, version: "latest")
    }
}
```

--------------------------------

### LeanTech Webhooks

Source: https://docs.leantech.me/v2.0-KSA/docs/how-to-use-account-verification

Documentation for setting up and utilizing webhooks with LeanTech services. This covers the general webhook setup, the structure of webhook payloads, and a library of available webhooks.

```APIDOC
APIDOC:
  Webhooks:
    Setup:
      - General guidelines for configuring webhooks to receive real-time notifications.
    Webhook Structure:
      - Details on the format and content of webhook payloads, including event types and data fields.
    Webhook Library:
      - A catalog of available webhooks, describing the events they signify and the data they provide.
```

--------------------------------

### Example: DNS Lookup using nslookup

Source: https://docs.leantech.me/v2.0-KSA/docs/webhooks

A command-line example using 'nslookup' to resolve a Leantech webhook domain name to its IP address. This is useful for understanding the DNS-based whitelisting mechanism.

```bash
# For Production:
nslookup webhooks.sa.leantech.me

# For Sandbox:
nslookup webhooks.sandbox.sa.leantech.me
```

--------------------------------

### Python mTLS Example

Source: https://docs.leantech.me/v2.0-KSA/docs/how-to-set-up-mtls

Illustrates how to perform an mTLS request in Python using the requests library. It demonstrates setting up the request with custom headers, the certificate and key files, and the CA file for verification.

```python
import requests

getBanksUrl = 'https://api.sa.leantech.me/banks/v1/'

headers = {'lean-app-token': '<LEAN_APP_TOKEN>', 'Content-Type': 'application/json'}

result = requests.get(
    getBanksUrl,
    headers=headers,
    cert=('cert.crt', 'key.pem'), # Use the path to your own certificate and private key here
    verify='ca.pem'
    )

if (result.status_code == 200) :
    print (result.json())
else :
    print (f"Error - {result.json()['status']}: {result.json()['message']}")
```

--------------------------------

### .NET/C# mTLS Integration

Source: https://docs.leantech.me/v2.0-KSA/docs/how-to-set-up-mtls

Provides guidance for setting up mTLS authentication in .NET/C# applications. Refer to the linked GitHub repository for detailed instructions and code examples.

```link
https://github.com/leantechnologies/lfs-mtls
```

--------------------------------

### Import Lean SDK in Swift

Source: https://docs.leantech.me/v2.0-KSA/docs/ios

How to import the Lean SDK into your Swift files after installation.

```swift
import LeanSDK
```

--------------------------------

### SwiftUI View State and Linking

Source: https://docs.leantech.me/v2.0-KSA/docs/ios

Demonstrates how to present the Lean SDK view within a SwiftUI application using `.fullScreenCover` and initiate the linking process with success and error callbacks.

```swift
// ContentView.swift

import SwiftUI
import LeanSDK

struct ContentView: View {
    @State private var isPresented = false
    var linkPermissions = ArrayOf<LeanPermission>

    var body: some View {
        VStack {
            Button("Link", action: { handleLink() })
        }
    }
    .fullScreenCover(isPresented: $isPresented, content: {
        Lean.manager.view.ignoresSafeArea()
    })

    func handleLink() {
        Lean.manager
                .connect(customerId: String, permissions: linkPermissions, failRedirectUrl: String, successRedirectUrl: String, customization: LeanCustomization?, success: {
                    print("Entity Linked")
                    isPresented = false
                }, error: { (status) in
                    print(status.status)
                    print(status.message)
                    print(status.method)
                    isPresented = false
                })
        isPresented = true
    }
}
```

--------------------------------

### Payouts Access and User Roles

Source: https://docs.leantech.me/v2.0-KSA/docs/getting-started-with-payouts

Information on how to gain access to the Payouts feature. It details the 'Financial Controller' role and the process of inviting additional users to manage payouts via the Lean Application Dashboard.

```APIDOC
User Roles:
- Financial Controller: Grants access to the Payouts tab in the dashboard.

Process:
1. The first user to sign up on Lean's Application Dashboard is automatically assigned the 'Financial Controller' role.
2. To grant access to other users, invite them via the 'Team' tab on the dashboard and assign them the 'Financial Controller' role.
```

--------------------------------

### Install iOS Pods

Source: https://docs.leantech.me/v2.0-KSA/docs/react-native

Navigates to the iOS directory and installs the necessary pods for the React Native project.

```shell
cd ios
pod install
```

--------------------------------

### Node.js mTLS Example

Source: https://docs.leantech.me/v2.0-KSA/docs/how-to-set-up-mtls

Demonstrates how to make an mTLS request using Node.js with the axios library. It shows how to configure the https.Agent with your application's certificate, private key, and the Lean certificate chain.

```javascript
const fs = require('fs')
const https = require('https')
const axios = require('axios')

const httpsAgent = new https.Agent({
  // This is your application certificate
  cert: fs.readFileSync('cert.crt'),
  // This is your private key associated with application certificate
  key: fs.readFileSync('key.pem'),
  // This is Lean's public certificate chain.
  ca: fs.readFileSync('ca.pem'),
})

const start = async () => {
  try {
    const request = await axios({
      method: 'post',
      headers: {
        'lean-app-token': 'LEAN_APP_TOKEN',
      },
      httpsAgent,
      // You can change the end point per your need. This endpoint is good for
      // testing mTLS
      url: 'https://api.sa.leantech.me/customers/v1',
      withCredentials: true,
      jar: true,
    })
    console.log(request)
  } catch (error) {
    console.log(error)
  }
}

start()
```

--------------------------------

### LinkSDK Integration

Source: https://docs.leantech.me/v2.0-KSA/docs/differences-retail-corporate

Guides for integrating the LinkSDK across different platforms including Web, iOS, Android, and React Native. Covers customization options and status management.

```APIDOC
LinkSDK Integration:
  - Web: https://docs.leantech.me/v2.0-KSA/docs/web
  - iOS: https://docs.leantech.me/v2.0-KSA/docs/ios
  - Android: https://docs.leantech.me/v2.0-KSA/docs/android
  - React Native: https://docs.leantech.me/v2.0-KSA/docs/react-native
  - Customization: https://docs.leantech.me/v2.0-KSA/docs/customization
  - LinkSDK statuses: https://docs.leantech.me/v2.0-KSA/docs/linksdk-statuses
  - Create your own bank list: https://docs.leantech.me/v2.0-KSA/docs/create-your-own-bank-list
```

--------------------------------

### Webhook Management

Source: https://docs.leantech.me/v2.0-KSA/docs/how-to-use-hyperlink-product

Information regarding the setup and usage of webhooks for receiving real-time notifications from the LeanTech platform.

```APIDOC
WEBHOOKS:
  Webhooks: General information about setting up and using webhooks.
  Webhook Structure: Details on the format and content of webhook payloads.
  Webhook Library: A collection of available webhooks and their purposes.
```

--------------------------------

### Setup SDK with Version

Source: https://docs.leantech.me/v2.0-KSA/docs/react-native

Shows how to set up the LinkSDK manager with a specific version. It highlights the importance of using a specific version for stability and explains the 'latest' alias.

```swift
Lean.manager.setup(
    appToken: String,
    sandbox: true,
    version: "latest"
    )
```

--------------------------------

### UIKit Linking Method

Source: https://docs.leantech.me/v2.0-KSA/docs/ios

Illustrates how to call the `connect` method from a `UIViewController`, specifying the `presentingViewController`, customer details, permissions, and handling success/error callbacks.

```swift
// ViewController.swift

import UIKit
import LeanSDK

class ViewController: UIViewController {
    var connectPermissions = ArrayOf<LeanPermission>

    override func ViewDidLoad() {
        super.viewDidLoad()
        Lean.manager.setup(appToken: String, sandbox: true, version: "latest")
    }
}
    @IBAction func handleLink(_sender: Any) {
        Lean.manager.connect(
            presentingViewController: self,
            customerId: String,
            permissions: connectPermissions,
            bankId: nil,
          	failRedirectUrl: String,
          	successRedirectUrl: String,
            customization: LeanCustomization?,
            success: { status in
                print("Entity Linked")
            }, error: { (status) in
                print(status)
            }
        )
    }
```

--------------------------------

### LeanTech LinkSDK Integration

Source: https://docs.leantech.me/v2.0-KSA/docs/creating-an-entity

Guides for integrating the LeanTech LinkSDK across different platforms including Web, iOS, Android, and React Native. Also covers customization and status management.

```APIDOC
## LINKSDK
  * [Web](https://docs.leantech.me/v2.0-KSA/docs/web)
  * [iOS](https://docs.leantech.me/v2.0-KSA/docs/ios)
  * [Android](https://docs.leantech.me/v2.0-KSA/docs/android)
  * [React Native](https://docs.leantech.me/v2.0-KSA/docs/react-native)
  * [Customization](https://docs.leantech.me/v2.0-KSA/docs/customization)
  * [LinkSDK statuses](https://docs.leantech.me/v2.0-KSA/docs/linksdk-statuses)
  * [Create your own bank list](https://docs.leantech.me/v2.0-KSA/docs/create-your-own-bank-list)
```

--------------------------------

### Account Verification API Request Example

Source: https://docs.leantech.me/v2.0-KSA/docs/how-to-use-account-verification

Demonstrates how to make a POST request to the LeanTech Account Verification API for IBAN verification using cURL. It includes headers and a sample JSON payload with personal identification details.

```curl
curl --request POST \
     --url https://sandbox.sa.leantech.me/verifications/v2/iban \
     --header 'accept: */*' \
     --header 'content-type: application/json' \
     --data '\
{
  "type": "PERSONAL",
  "iban": "SA2810000011100000461309",
  "identifications": [
    {
      "type": "NATIONAL_ID",
      "value": "1106972886"
    }
  ]
}
'
```

--------------------------------

### LeanTech KSA LinkSDK Integration

Source: https://docs.leantech.me/v2.0-KSA/docs/overview

Guides for integrating the LeanTech LinkSDK across different platforms including Web, iOS, Android, and React Native, along with customization and status management.

```APIDOC
APIDOC:
  LinkSDK - Web:
    Description: Instructions for integrating LinkSDK into web applications.
    Key Features:
      - Embeddable UI components.
      - JavaScript SDK methods for initiating connections.

  LinkSDK - iOS:
    Description: Guide for integrating LinkSDK into native iOS applications.
    Key Features:
      - Swift/Objective-C SDK.
      - Handling callbacks and responses.

  LinkSDK - Android:
    Description: Guide for integrating LinkSDK into native Android applications.
    Key Features:
      - Kotlin/Java SDK.
      - Managing activity lifecycles and results.

  LinkSDK - React Native:
    Description: Instructions for integrating LinkSDK into React Native applications.
    Key Features:
      - React Native bridge module.
      - Cross-platform compatibility.

  LinkSDK - Customization:
    Description: Options for customizing the appearance and behavior of the LinkSDK.
    Customization Points:
      - Branding (colors, logos).
      - Flow configuration.

  LinkSDK statuses:
    Description: Explanation of various statuses that LinkSDK connections can have.
    Common Statuses:
      - 'pending': Connection is in progress.
      - 'connected': Connection established successfully.
      - 'failed': Connection attempt failed.
      - 'revoked': User revoked consent.

  Create your own bank list:
    Description: How to configure and provide a custom list of banks for the LinkSDK.
```

--------------------------------

### Link SDK Initialization with Customization

Source: https://docs.leantech.me/v2.0-KSA/docs/customization

Demonstrates how to initialize the Lean SDK with various customization options for the dialog, theme, button text, button border radius, and overlay color. This snippet shows the structure of the customization object passed to the `Lean.connect` method.

```javascript
Lean.connect({
  app_token: "123",
  customer_id: "123",
  permissions: ["identity", "balance", "accounts", "transactions"],
  sandbox: true,
  customization: {
    dialog_mode: string,
    theme_color: string,
    button_text_color: string,
    button_border_radius: string,
    overlay_color: string,
  },
});
```

--------------------------------

### Initialize Lean SDK Instance

Source: https://docs.leantech.me/v2.0-KSA/docs/android

Create an instance of the Lean SDK using the Builder pattern. Essential parameters include the app token and permissions. Optional methods like `showLogs()` and `sandbox()` can also be configured.

```Kotlin
val lean = Lean.Builder()
    .setAppToken("YOUR_APP_TOKEN")
    .setVersion("latest")
    .showLogs()
    .sandbox(true)
    .build()
```

--------------------------------

### Setup SDK Language

Source: https://docs.leantech.me/v2.0-KSA/docs/ios

This Swift code snippet shows how to set the language for the Link SDK. The SDK supports English ('en') and Arabic ('ar'), with English as the default if no language is specified.

```swift
Lean.manager.setup(
    language: String,
    ...
)
```

--------------------------------

### Install react-native-webview Dependency

Source: https://docs.leantech.me/v2.0-KSA/docs/react-native

Installs the `react-native-webview` package, which is required if not already present in the project.

```javascript
yarn add react-native-webview
```

```javascript
npm install --save react-native-webview
```

--------------------------------

### LeanTech Webhook Documentation

Source: https://docs.leantech.me/v2.0-KSA/docs/creating-an-entity

Information on setting up and managing webhooks for LeanTech services, including webhook structure and a library of available webhooks.

```APIDOC
## WEBHOOKS
  * [Webhooks](https://docs.leantech.me/v2.0-KSA/docs/webhooks)
  * [Webhook Structure](https://docs.leantech.me/v2.0-KSA/docs/webhook-structure)
  * [Webhook Library](https://docs.leantech.me/v2.0-KSA/docs/webhook-library)
```

--------------------------------

### Install Lean React Native SDK

Source: https://docs.leantech.me/v2.0-KSA/docs/react-native

Installs the Lean React Native SDK package using either Yarn or npm.

```javascript
yarn add lean-react-native
```

```javascript
npm install lean-react-native
```

--------------------------------

### Get Results API Request

Source: https://docs.leantech.me/v2.0-KSA/docs/handling-asynchronous-requests

Demonstrates how to fetch the processed results using a GET request to the results endpoint, providing the 'results_id' obtained from the initial asynchronous request.

```curl
curl -X GET 'https://sandbox.sa.leantech.me/data/v2/results/6dd9c7d2-1c8c-4862-bb1f-fcf52f5033d4?page=0&size=50' \
  --header 'Content-Type: application/json' \
  --header 'lean-app-token: YOUR_APP_TOKEN' \

```

--------------------------------

### cURL Example for Creating a Customer

Source: https://docs.leantech.me/v2.0-KSA/docs/creating-a-customer

This code snippet demonstrates how to create a customer using cURL. It sends a POST request to the `/customers/v1` endpoint with the necessary headers, including your application token and content type, and a JSON payload containing the `app_user_id`.

```bash
curl -X POST 'https://sandbox.sa.leantech.me/customers/v1/' \
  --header 'Content-Type: application/json' \
  --header 'lean-app-token: YOUR_APP_TOKEN' \
  --data-raw '{
    "app_user_id": "IDENTIFIER_FOR_CUSTOMER"
  }'
```

--------------------------------

### Create GET Endpoint for Banks

Source: https://docs.leantech.me/v2.0-KSA/docs/create-your-own-bank-list

Sets up an Express.js GET endpoint '/lean-banks' to query a database for all banks, filter out unavailable ones based on active and enabled status, and return the filtered list.

```javascript
const express = require('express');
const fetch = require('node-fetch');
const app = express();
app.use(express.json());

// start your application and connect to your database
app.listen(process.env.PORT || 3000, 
	() => db.connect(function(err) { if (err) throw err }));

// Set up a GET endpoint for lean banks
app.get('/lean-banks', (request, response) => {
	
  // query your database for all banks and serialise to JSON	
  var banks = db.query('SELECT * FROM banks',
    function (err, results) {
      if (err) throw err;

      var results = results.map((mysqlObj, index) => {
        return Object.assign({}, mysqlObj);
      });
    }
  )

  // filter out unavailable banks
  banks.filter(bank => (
    bank.availability.active.data === true &&
    bank.availability.enabled.data === true
  ))

  // return the bank list
  response.send(banks)
})
```

--------------------------------

### Example: Verifying Signature in Node.js

Source: https://docs.leantech.me/v2.0-KSA/docs/webhooks

A Node.js code example illustrating how to verify a webhook signature. It computes the HMAC-SHA512 of the request body using the webhook secret and compares it with the 'lean-signature' header value.

```javascript
const crypto = require('crypto');

function verifySignature(requestBody, leanSignature, webhookSecret) {
    const hmac = crypto.createHmac('sha512', webhookSecret);
    hmac.update(requestBody);
    const expectedSignature = 'sha512=' + hmac.digest('hex');
    return crypto.timingSafeEqual(Buffer.from(expectedSignature), Buffer.from(leanSignature));
}
```

--------------------------------

### Initialize LinkSDK with OAuth

Source: https://docs.leantech.me/v2.0-KSA/docs/authentication

Demonstrates how to initialize the LinkSDK with OAuth credentials, including access token, app token, customer ID, permissions, sandbox mode, redirect URLs, and optional access timeframes and account types.

```javascript
Lean.Connect({
  access_token: "YOUR_JWT",
  app_token: "YOUR_APP_TOKEN",
  customer_id: customer_id,
  permissions: [
    "identity","accounts","balance","transactions", "identities", 
    "scheduled_payments", "standing_orders", "direct_debits", "beneficiaries"
  ],
  sandbox: true,
  fail_redirect_url: "",
  success_redirect_url: "",
  access_from: "2023-03-07T09:33:30.477Z", //optional
  access_to: "2023-06-07T09:33:30.477Z", //optional
  account_type: "BUSINESS" | "PERSONAL"
})
```

--------------------------------

### Example: Verifying Signature in Python

Source: https://docs.leantech.me/v2.0-KSA/docs/webhooks

A Python code example demonstrating how to verify an incoming webhook signature. It calculates the HMAC-SHA512 hash of the request body using the webhook secret and compares it with the signature provided in the 'lean-signature' header.

```python
import hmac
import hashlib

def verify_signature(request_body, lean_signature, webhook_secret):
    hash_object = hmac.new(webhook_secret.encode('utf-8'), request_body.encode('utf-8'), hashlib.sha512)
    expected_signature = "sha512=" + hash_object.hexdigest()
    return hmac.compare_digest(expected_signature, lean_signature)
```

--------------------------------

### LeanTech KSA Data API Reference

Source: https://docs.leantech.me/v2.0-KSA/docs/getting-started-with-data

Provides access to various financial data and insights after a customer connects to their bank. Includes endpoints for raw data and verification/enrichment.

```APIDOC
Raw Data APIs:

Get Accounts: https://docs.leantech.me/v2.0-KSA/reference/fetchaccounts
Get current user's identity: https://docs.leantech.me/v2.0-KSA/reference/fetchcurrentidentity#/
Get Balances: https://docs.leantech.me/v2.0-KSA/reference/fetchbalances#/
Get Transactions: https://docs.leantech.me/v2.0-KSA/reference/fetchtransactions#/
Get Beneficiaries: https://docs.leantech.me/v2.0-KSA/reference/fetchbeneficiaries#/
Get Direct Debits: https://docs.leantech.me/v2.0-KSA/reference/fetchdirectdebits#/
Get Identities: https://docs.leantech.me/v2.0-KSA/reference/fetchallidentities#/
Get Scheduled Payments: https://docs.leantech.me/v2.0-KSA/reference/fetchscheduledpayments#/
Get Standing Orders: https://docs.leantech.me/v2.0-KSA/reference/getstandingorders#/

Verification & Data Enrichment APIs:

Get Account Verification (IBAN): https://docs.leantech.me/v2.0-KSA/reference/verifyiban#/
Get Account Verification (entity): https://docs.leantech.me/v2.0-KSA/reference/verifyentity#/
Get Income (Retail only): https://docs.leantech.me/v2.0-KSA/reference/getincome#/
Get Expenses (Retail only): https://docs.leantech.me/v2.0-KSA/reference/getexpenses#/
```

--------------------------------

### LeanTech API - Get Entities

Source: https://docs.leantech.me/v2.0-KSA/docs/sama-requirements

API endpoint to retrieve entities, suggested for displaying consent information on a dashboard.

```APIDOC
GET /entities

Description:
  Retrieves a list of entities, which can be used to display consent information to the end user.

Response Data Fields:
  - bank_name: The name or nickname of the bank.
  - account_type: The type of the account (if provided).
  - expiry_date: The date when the consent will end.
  - last_synced: The date and time of the last data sync from the connected account.
  - status: The status of the consent ('Active' or 'Expired').
  - warnings: Any warnings or alerts related to the consent (e.g., nearing expiry).
  - manage_button: An indicator or link to manage the consent (revoke or view details).
```

--------------------------------

### Error Status Dictionary

Source: https://docs.leantech.me/v2.0-KSA/docs/ios

Defines the structure of the `LeanStatus` dictionary returned upon failure, containing status, method, and message information.

```swift
{
    status: "ERROR",
    method: "LINK",
    message: "Some message"
}
```

--------------------------------

### LeanTech KSA API Reference

Source: https://docs.leantech.me/v2.0-KSA/docs/how-to-use-account-verification

This section provides detailed API documentation for LeanTech's v2.0 services in KSA. It includes information on endpoints, request/response formats, and usage examples for various functionalities like customer and entity creation, data fetching, and consent management.

```APIDOC
APIDOC:
  Overview:
    Provides a general overview of the LeanTech KSA v2.0 API.

  Creating a customer:
    Endpoint: POST /customers
    Description: Creates a new customer entity.
    Request Body:
      customer_details: Object (Required) - Details of the customer.
    Response:
      customer_id: String - Unique identifier for the created customer.

  Creating an entity:
    Endpoint: POST /entities
    Description: Creates a new entity (e.g., business, individual).
    Request Body:
      entity_details: Object (Required) - Details of the entity.
    Response:
      entity_id: String - Unique identifier for the created entity.

  Fetching data:
    Endpoint: GET /data/{customer_id}
    Description: Retrieves financial data for a given customer.
    Parameters:
      customer_id: String (Required) - The ID of the customer.
    Response:
      financial_data: Object - The fetched financial data.

  Handling asynchronous responses:
    Description: Explains how to handle responses that are processed asynchronously.
    Key Concepts:
      - Webhooks: Mechanisms for receiving real-time updates.
      - Status Polling: Methods for checking the status of ongoing operations.

  Allowing customers to revoke consent:
    Endpoint: DELETE /consent/{consent_id}
    Description: Revokes a previously granted consent.
    Parameters:
      consent_id: String (Required) - The ID of the consent to revoke.
    Response:
      status: String - Indicates the success or failure of the revocation.

  Handling invalid consents:
    Description: Details on how to manage and respond to invalid or expired consents.

  Differences between retail and corporate integrations:
    Description: Outlines the distinctions and considerations for integrating with retail vs. corporate clients.
```

--------------------------------

### Lean API Reference Overview

Source: https://docs.leantech.me/v2.0-KSA/docs/overview

Provides details on Lean's APIs, including URIs, request and response parameters. It also allows for testing sandbox APIs and viewing sample responses.

```APIDOC
Lean API Reference:
  - URI: Available for each API.
  - Request Parameters: Details provided for each API.
  - Response Parameters: Details provided for each API.
  - Testing Sandbox APIs: Functionality to test APIs directly.
  - Sample Responses: Option to view example responses.
```

--------------------------------

### Making an OAuth Call to a Lean API

Source: https://docs.leantech.me/v2.0-KSA/docs/authentication

This example demonstrates how to make a POST request to a Lean API endpoint using the obtained JWT as a Bearer token in the Authorization header.

```curl
curl -X POST 'https://api2.sa.leantech.me/customers/v1' \
--header 'Content-Type: application/json'
--header 'Authorization: Bearer YOUR_JWT' \
--data-raw '{
  "app_user_id": "001"
}'
```

--------------------------------

### Fetch Available Bank Identifiers

Source: https://docs.leantech.me/v2.0-KSA/docs/web

Provides an example cURL command to retrieve a list of available `bank_identifiers` for your application from the `/banks/v1/` endpoint. This is used for skipping the bank selection screen in the LinkSDK.

```cURL
curl -X GET 'https://api.sa.leantech.me/banks/v1/' \
  --header 'lean-app-token: 2c9a80897169b1dd01716a0339e30003' \
  --ca-cert ca.pem \
  --cert cert.crt \
  --key key.pem
```

--------------------------------

### LinkSDK Functionality

Source: https://docs.leantech.me/v2.0-KSA/docs/how-to-use-hyperlink-product

Documentation for the LinkSDK, covering its implementation across different platforms and customization options.

```APIDOC
LinkSDK:
  Web: Integration guide for the Web platform.
  iOS: Integration guide for the iOS platform.
  Android: Integration guide for the Android platform.
  React Native: Integration guide for the React Native platform.
  Customization: Options for customizing the LinkSDK interface and behavior.
  LinkSDK statuses: Explanation of various LinkSDK statuses and their meanings.
  Create your own bank list: Guide on creating a custom list of banks for the LinkSDK.
```

--------------------------------

### LeanTech KSA Webhooks

Source: https://docs.leantech.me/v2.0-KSA/docs/overview

Documentation on setting up and utilizing webhooks for real-time notifications from LeanTech, including webhook structure and a library of available webhooks.

```APIDOC
APIDOC:
  Webhooks:
    Description: General information about setting up and receiving webhook notifications.
    Setup:
      - Provide your webhook endpoint URL in the LeanTech dashboard.
      - Ensure your endpoint is publicly accessible and configured to handle POST requests.

  Webhook Structure:
    Description: Defines the standard format of data sent in webhook payloads.
    Common Fields:
      - event_type: The type of event that triggered the webhook (e.g., 'data_ready', 'payment_status_update').
      - payload: The data associated with the event.
      - timestamp: The time the event occurred.

  Webhook Library:
    Description: A catalog of available webhook events and their corresponding payload structures.
    Example Events:
      - 'customer.created': Notifies when a new customer is successfully created.
      - 'entity.linked': Notifies when a bank entity is successfully linked.
      - 'payout.completed': Notifies when a payout transaction has been completed.
```

--------------------------------

### Change SDK Language

Source: https://docs.leantech.me/v2.0-KSA/docs/web

This JavaScript example shows how to set the language for the Lean SDK. It supports both English ('en') and Arabic ('ar'), ensuring a localized user experience. The default language is English.

```javascript
Lean.connect({
  app_token: "2c9a80897169b1dd01716a0339e30003",
  customer_id: "552e8102b3c14401a36ac14fadab94de",
  permissions: ["identity","accounts","balance","transactions", "identities", "scheduledPayments", "standingOrders", "directDebits", "beneficiaries"],
  sandbox: true,
  fail_redirect_url: "",
  success_redirect_url: "",
  language: "ar"
});
```

--------------------------------

### LeanTech KSA v2.0 API Reference

Source: https://docs.leantech.me/v2.0-KSA/docs/creating-an-entity

This section details the API endpoints and functionalities available for the LeanTech KSA v2.0 platform. It includes information on creating entities, fetching data, handling consents, and more.

```APIDOC
## RAW Data API
  * [Overview](https://docs.leantech.me/v2.0-KSA/docs/overview)
  * [Creating a customer](https://docs.leantech.me/v2.0-KSA/docs/creating-a-customer)
  * [Creating an entity](https://docs.leantech.me/v2.0-KSA/docs/creating-an-entity)
  * [Explaining the consent](https://docs.leantech.me/v2.0-KSA/docs/explaining-the-consent)
  * [Fetching data](https://docs.leantech.me/v2.0-KSA/docs/getting-started-with-data)
  * [Handling asynchronous responses](https://docs.leantech.me/v2.0-KSA/docs/handling-asynchronous-requests)
  * [Allowing your customers to revoke consent](https://docs.leantech.me/v2.0-KSA/docs/allowing-your-customers-to-revoke-consent)
  * [Handling invalid consents](https://docs.leantech.me/v2.0-KSA/docs/handle-expired-consent)
  * [Differences between retail and corporate integrations](https://docs.leantech.me/v2.0-KSA/docs/differences-retail-corporate)

## VERIFICATION & Data Enrichment
  * [How to use Account Verification](https://docs.leantech.me/v2.0-KSA/docs/how-to-use-account-verification)
  * [How to use Freelancer Verification](https://docs.leantech.me/v2.0-KSA/docs/how-to-use-freelancer-verification)
  * [How to use Data Enrichment APIs](https://docs.leantech.me/v2.0-KSA/docs/how-to-use-financial-insights-apis)
  * [How to use HyperLink](https://docs.leantech.me/v2.0-KSA/docs/how-to-use-hyperlink-product)
  * [How to use Reports](https://docs.leantech.me/v2.0-KSA/docs/how-to-use-reports-product)
  * [Using HyperLink & Reports via API](https://docs.leantech.me/v2.0-KSA/docs/using-hyperlink-reports-via-api)

## Payouts
  * [Getting Started with Payouts](https://docs.leantech.me/v2.0-KSA/docs/getting-started-with-payouts)
  * [Making payments with Payouts](https://docs.leantech.me/v2.0-KSA/docs/making-payments-with-payouts)
```

--------------------------------

### Account Verification API Response Example

Source: https://docs.leantech.me/v2.0-KSA/docs/how-to-use-account-verification

Provides a sample JSON response from the LeanTech Account Verification API after a successful IBAN verification. It includes status, verification results, bank details, and masked account holder name.

```JSON
{
    "status": "OK",
    "results_id": "e894ede4-dd81-41fb-b52d-fb4fec16c16c",
    "message": "Data successfully retrieved",
    "timestamp": "2025-05-19T12:09:54.672818827Z",
    "meta": null,
    "status_detail": null,
    "verifications": {
        "iban_ownership_verified": true,
        "swift_code": "ALBISARI",
        "bank_name": {
            "en": "AlBilad Bank",
            "ar": "بنك البلاد"
        },
        "bank_code": "١٥",
        "account_status": "ACTIVE",
        "account_holder_name": "NA****AL**** IN****RM****IO**** SY****E****",
        "verification_method": "SARIE"
    }
}
```

--------------------------------

### Endpoint URLs

Source: https://docs.leantech.me/v2.0-KSA/docs/introduction

Provides the base URLs for sandbox and production environments.

```APIDOC
Sandbox Endpoint:
  https://sandbox.sa.leantech.me

Production Endpoint:
  https://api.sa.leantech.me
```
Tokens:
Raw