Skip to main content

Get started with Lending API

Learn how to perform the initial setup for the Lending API product

Your lending journey

Our Lending API supports the data collection step of your lending journey, which starts in your own web application. Enable Lending API and configure it, then embed our Link SDK in your app to handle the auth flow. Determine where the collected data will be stored and manage the subsequent steps of the lending process in your app.

Enable Lending API​

  1. Open the Codat Portal and sign in.
  2. Click on Settings > Organizational settings > Products.
  3. In the list of products, find Lending API and click Enable. Then, follow the on-screen prompt.

Configure Lending API​

Data sources​

In the Codat Portal, navigate to Settings > Integrations to enable and set up the integrations that will serve as a data source for the product. Follow the respective guides for integration-specific instructions.

Data source coverage varies by feature, so be sure to review the coverage for the features you want to use.

Accounting​

Premium
NL
UK
Premium
Premium
On-premise
Premium
On-premise
UK
Ireland
UK
US
Ireland
Canada
France
Germany
Spain
Premium

Banking​

AU
NZ

Commerce​

K Series
Subscription data
Subscription data
Subscription data

Authorization flow​

As part of using the Lending API, you will need your customers to authorize your access to their data. To do so, use Link - our pre-built, conversion-optimized white-label authorization flow.

We recommend you fully embed this auth flow in your experience by using our Link SDK in your front-end code. You can also choose our out-of-the-box Hosted Link auth flow option to get up and running as quick as possible.

The solution lets you tailor the authorization journey to your business needs. You can:

Data types​

Set the minimum set of data types required for the Lending API to fetch on first link. Each feature may also have additional data type requirements, so be sure to review these for the feature you want to use.

In the Codat Portal, navigate to Settings > Integrations > Data types. As a minimum, you need the following data types enabled:

Data sourceAccountingBankingCommerce
Data typescompany
chartOfAccounts
balanceSheet
profitAndLoss
bankAccounts
bankTransactions		banking-accounts
banking-transactions
banking-transactionCategories
banking-accountBalances		commerce-companyInfo
commerce-customers
commerce-orders

Configure the solution to refresh data when you need it by setting a synchronization frequency on the same screen. We recommend setting it to a daily or a monthly sync.

Webhooks​

Codat supports a range of event types you can listen to that help you manage your data pipelines. Many of these events send a message for each dataType separately.

In the Codat Portal, navigate to Settings > Webhooks > Create consumer and click Add endpoint to add a new webhook consumer endpoint and get the most out of Lending API:

Use Lending API​

Before you can collect your SMB customer's data, you need to create a Codat

The fallback content to display on prerendering
and connect it to a data source (for example, an accounting platform). You can do that in two ways:

Remember to authenticate if you are making calls to our API. Navigate to Developers > API keys in the Portal to pick up your authorization header.

To establish a connection to a data source and sync business data, your customer must grant you access. They can do so using our Link auth flow solution, which we recommend you use in your app.

Once the connection is established, Codat will retrieve data for the data types you have previously set up to fetch on first link. You can listen for the NewCompanySynchronized event to get notified once these initial syncs are complete, and at least one of them is successful.

  • Underwriters

    Make use of our Excel export reports to audit source data and perform underwriting with confidence.

  • Developers

    Interact with our Lending API reference to understand required body parameters, responses, and errors. Use our client SDKs to simplify your implementation journey.

Client libraries​

Use our comprehensive Lending API library to kick-start and simplify your build. Simply install the library in one of the supported languages and pass your base64-encoded API key to the constructor.

Install​

NPM​
npm add @codat/lending
Yarn​
yarn add @codat/lending

Initialize​

import { CodatBankFeeds } from "@codat/lending";

const lendingClient = new CodatLending({
        security: {
            authHeader: "Basic BASE_64_ENCODED(API_KEY)",
        },
    });

Explore the features that make up our Lending API:

Was this page useful?
❤️
👍
🤔
👎
😭

Contents

Suggest edits