Integrations

An integration connects LendAPI to a third-party data or service provider, such as a credit bureau, a bank-data aggregator or an identity-verification service. You add your own credentials for the provider once. LendAPI then calls the provider during an application, stores the response on the application, and turns the important fields into variables that your rules, pricing, templates and contracts can use.

This guide is an overview of how all integrations work. Each provider has its own credentials and options, shown in the dashboard when you configure it.

Key concepts

• Provider: the third-party service, for example Equifax or Plaid.
• Integration: your account's connection to a provider: its credentials, settings and on/off status.
• Credentials: the keys, IDs, certificates or passwords the provider gave you. They are stored per environment.
• Status: Active or Disabled. Disabling an integration keeps its credentials and mappings, so you can turn it back on later.
• Provider variables: variables created automatically when an integration is enabled. They hold values from the provider's response, such as a credit score or a verification result.
• Mappings: for providers that support it, which of your variables are sent as each field of the provider request.
• Integration call: one request to a provider for one application, with its response.

How it works

flowchart LR
    A[Configure integration<br/>Workflows → Integrations] --> B[Add it to a step<br/>Product Studio or Flow Builder]
    B --> C[Application reaches step]
    C --> D[LendAPI calls provider<br/>with mapped variables]
    D --> E[Response stored on application]
    E --> F[Provider variables filled in]
    F --> G[Rules, pricing, templates,<br/>contracts use the values]

Supported providers

These are the providers in the Workflows → Integrations catalog, listed by the catalog's categories and names.

Set up an integration

Find an integration

1. Go to Workflows → Integrations.
2. Use the Active, Disabled and All tabs, the category filter, or the search box to find the provider.

Enable a provider

1. On the provider's card, click Enable. The integration panel opens.
2. Enter your credentials (see Enter credentials) and click Save Changes.

When you enable a provider, LendAPI adds its provider variables to your account.

Manage an enabled integration

On an enabled integration, click Manage. The integration panel has these tabs:

• Overview: the provider description, its Status (Active or Disabled), Last Updated and Modified By.
• Configuration: the credentials and settings for this provider.
• Mappings (on providers that support it): which variable feeds each request field.

Enter credentials

1. On an enabled integration, open the Configuration tab and click Edit. (When you are enabling a provider, the form is already open.)
2. Fill in the fields the provider requires. Typical fields are a client ID, an API key or secret, a username and password, or a certificate file. Some providers also ask which of their environments to use, for example Sandbox or Production.
3. Click Save Changes. Secret fields are masked in the form.

Credentials are always placeholders in our examples. Use the values your provider issued to you, for example:

Client ID:   your-client-id
Secret Key:  sk_test_xxxxxxxxxxxxxxxx
Environment: Sandbox

❗️

Keep Sandbox and live credentials apart

Never paste live provider credentials into Sandbox, or test credentials into Production. Sandbox applications call the provider with the credentials saved in Sandbox, so live credentials there make real calls to the provider with test data.

Sandbox vs. Production

LendAPI keeps integration settings separately for each environment. Switch the environment selector in the dashboard header to Sandbox or Production before you open Integrations, and configure each one:

• In Sandbox, use the provider's test or sandbox credentials and endpoints.
• In Production, use your live credentials.

Applications created with a test_ API key, or in the dashboard's Sandbox, call the Sandbox integration settings. See Sandbox and Live.

Turn an integration on or off

Use the switch on the integration's card, or the Status switch on its Overview tab, to change it between Active and Disabled. Disabling keeps the credentials and mappings, so you can turn it back on later.

Map request fields

For providers that show a Mappings tab, pick the variable that supplies each field of the provider request, for example which variable holds the applicant's SSN or business EIN. Map every field marked as required.

Use integration results

Use integrations in your flows

An integration only runs when your product or flow calls it.

• Product Studio: in a page's properties, under On Continue, choose an Initial Provider (runs when the applicant continues from the page, before the decision tree) and/or a Final Provider (runs after the decision tree completes).
• Flow Builder (beta): add an Integration node and choose the integration. Its results are available to the nodes that follow.

After the call, use the provider variables like any other variable:

• in Rule Studio decision trees, for example a rule on a credit score returned by a bureau
• in pricing engines
• in email and SMS templates and contracts

Where results appear

• On the application: open the application's Integration tab. Integration Calls lists every provider call with its status. Open a call to see the response.
• As variables: the application's Data tab lists the application's variables, including provider variables, and shows which provider each one comes from.
• Through the API: read the variables with Get application data. For bureaus that return a PDF credit report, use Get credit report PDF of an application.

Use it via the API

Integrations are configured in the dashboard. There is no public API for adding or editing integration credentials. Provider results are available on the application through the endpoints linked above.

Access and best practices

Permissions

Configuring integrations needs the Integrations module under Workflows. It is marked sensitive because it exposes credentials. View lets a user see integrations. Edit lets them change credentials, mappings and status. Viewing results on an application needs the Agent Dashboard Integration tab. See Roles and Permissions.

Best practices

• Start in Sandbox with the provider's test credentials, and run test applications through every path before going live.
• Limit who can edit integrations. Give Edit only to the few admins who manage provider contracts.
• Run expensive pulls late. Put costly calls (hard credit pulls, bank-data reports) after cheaper checks, for example as a Final Provider or behind a Flow Builder condition, so you only pay for applicants who get that far.
• Check your mappings. After any mapping change, run a test application and review its Integration Calls.
• Rotate credentials in both environments when a provider issues new keys.

Related guides