Introduction

Welcome to the Lendflow API! This document describes how clients can integrate with Lendflow, to create and monitor capital solutions offered by Lendflow.

We currently have language bindings in Shell! You can view code examples in the area to the right, and you can switch the programming language of the examples with the tabs in the top right. If you would like to request any additional bindings, then please contact the Technology Team at tech@lendflow.io and we will aim to add them in the near future.

1. Authentication

Lendflow uses API Bearer Tokens to permit access to our API. You can register for a new Lendflow API key on our client portal in less than 60 seconds. The Bearer Token needs to be included in all API requests made to the API Service in the following form:

Authorization: Bearer [YOUR_TOKEN]

You must replace [YOUR_TOKEN] with your personal API key.

This endpoint allows user to get Bearer Token based on provided login credentials.

POST api/v1/auth/login

Use the following command

curl --request POST \
    "https://api.lendflow.com/api/v1/auth/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"qkunze@example.com\",
    \"password\": \"Asdf1234!?\"
}"

The above command returns JSON structured like this:


{
    "access_token": "YOUR_BEARER_TOKEN",
    "token_type": "bearer",
    "expires_in": 3600
}

The above command returns JSON structured like this:


{
    "message": "Your password has expired.",
    "errors": {
        "errors": {
            "password": [
                "Your password has expired. Please set a new one."
            ]
        }
    },
    "meta": {
        "error_code": "password_expired",
        "password_ttl_days": 14
    }
}

Received response:

Request failed with error:

Get User Details

Requires Authentication

This endpoint allows user to get his personal information.

GET api/v1/auth/me

Use the following command

curl --request GET \
    --get "https://api.lendflow.com/api/v1/auth/me" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

The above command returns JSON structured like this:


{
    "data": {
        "id": 1,
        "first_name": "Matthew",
        "last_name": "Watts",
        "email": "mwatts+client@lendflow.io",
        "pending_email": null,
        "widget_token": "zKjBboFlC2wPyi9i28dKEJKjAs5WWdZa",
        "created_at": "2021-04-29T14:05:30.000000Z"
    }
}

Received response:

Request failed with error:

Refresh access token

Requires Authentication

This endpoint creates a fresh token for the user. Our requirement is a 2hr expiration on a token. We do not want a user to be able to refresh a token 2 hours after its IAT.

Refreshing a token using tymon/jwt-auth actually retains the IAT from the original token. When we refresh a token we want to have a fresh IAT allowing that token to be good for another 2hrs from when it was issued.

POST api/v1/auth/refresh

Use the following command

curl --request POST \
    "https://api.lendflow.com/api/v1/auth/refresh" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

The above command returns JSON structured like this:


{
    "access_token": "YOUR_BEARER_TOKEN",
    "token_type": "bearer",
    "expires_in": 3600
}

Received response:

Request failed with error:

2. Capital Qualification

Legacy API endpoints

Pre-Qualification

Requires Authentication

This endpoint, allows registered users with historical financial data, to run a Pre-Qualification through the Lendflow system

POST api/v1/prequalification

Use the following command

curl --request POST \
    "https://api.lendflow.com/api/v1/prequalification" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": [
        {
            \"statement_date\": \"2021-06-19T15:01:23+0000\",
            \"statement_amount\": 12123.12
        },
        {
            \"statement_date\": \"2021-05-19T15:01:23+0000\",
            \"statement_amount\": 12123.12
        },
        {
            \"statement_date\": \"2021-04-19T15:01:23+0000\",
            \"statement_amount\": 12123.12
        }
    ]
}"

The above command returns JSON structured like this:


{
    "code": 200,
    "data": {
        "issue_date": "2021-01-06T11:23:26Z",
        "prequalification_total": 25000
    }
}

Received response:

Request failed with error:

Body Parameters

data Object[] optional

A collection of at least 3 months of bank statement data.

data[].statement_date string

Must be a valid date.

data[].statement_amount number

3. Capital Application

Legacy API endpoints

Apply for Capital

Requires Authentication

This endpoint, allows registered users, to submit a request for funding in the Lendflow system.

POST api/v1/application

Use the following command

curl --request POST \
    "https://api.lendflow.com/api/v1/application" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"sandbox\": false,
    \"dba_name\": \"My bussines INC\",
    \"first_name\": \"John\",
    \"last_name\": \"Doe\",
    \"phone_number\": \"+2125555555\",
    \"email_address\": \"qkunze@example.com\",
    \"use_of_funds\": \"Expand business\",
    \"amount_needed\": 300000,
    \"country\": \"US\",
    \"business_entity_type\": \"LLC\",
    \"business_start_date\": \"2021-12-03T14:50:14\",
    \"business_address\": \"25th Street 120\",
    \"business_city\": \"New York\",
    \"business_state\": \"NY\",
    \"business_zip\": \"10001\",
    \"owner_date_of_birth\": \"2021-12-03T14:50:14\",
    \"owner_home_address\": \"25th Street 120\",
    \"owner_city\": \"New York\",
    \"owner_state\": \"NY\",
    \"owner_zip\": \"10001\",
    \"owner_ssn\": \"123456789\",
    \"employer_identification_number\": \"123456789\",
    \"number_of_owners\": 17,
    \"other_owners\": [
        {
            \"first_name\": \"John\",
            \"last_name\": \"Doe\",
            \"email_address\": \"qkunze@example.com\",
            \"address\": \"25th Street 121\",
            \"country\": \"US\",
            \"city\": \"New York\",
            \"state\": \"NY\",
            \"zip\": \"10001\",
            \"ssn\": \"123456789\",
            \"dob\": \"2021-12-03T14:50:14\",
            \"ownership\": 50
        }
    ]
}"

The above command returns JSON structured like this:


{
    "code": 201,
    "data": {
        "application_identifier": "XXXX"
    }
}

Received response:

Request failed with error:

Body Parameters

sandbox boolean optional

dba_name string

first_name string

last_name string

phone_number string

email_address string

Must be a valid email address.

use_of_funds string

Expand business, Import goods, Purchase a vehicle, Other, Promote business, Improve cash flow, Payroll, Pay taxes, Purchase equipment, Purchase inventory, Remodel, Purchase real estate.

amount_needed number

country string

business_entity_type string

LLC, Sole Proprietorship, Partnership, Corporation, Cooperative, Non-profit, I’m not sure, I haven’t registered it yet.

business_start_date string

Must be a valid date.

business_address string

business_city string

Must not be greater than 50 characters.

business_state string

Two-letter state code.

business_zip string

owner_date_of_birth string

Must be a valid date.

owner_home_address string

owner_city string

owner_state string

Two-letter state code.

owner_zip string

owner_ssn string

employer_identification_number string

number_of_owners integer optional

other_owners object[] optional

other_owners[].first_name string

other_owners[].last_name string

other_owners[].email_address string

Must be a valid email address.

other_owners[].address string

other_owners[].country string optional

other_owners[].city string

Must not be greater than 50 characters.

other_owners[].state string

other_owners[].zip string

other_owners[].ssn string

other_owners[].dob string

Must be a valid date.

other_owners[].ownership number

Must be at least 0.01. Must not be greater than 100.

Retrieve Applications

Requires Authentication

This endpoint, allows registered users, to retrieve all applications that have been submitted through the integration widget and/or api.

GET api/v1/deals

Use the following command

curl --request GET \
    --get "https://api.lendflow.com/api/v1/deals" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

The above command returns JSON structured like this:


{
    "data": [
        {
            "uuid": "00020984-b812-4d99-a2cc-70684dc59b9f",
            "token": null,
            "business_name": "Repair Hub",
            "first_name": "Paul",
            "last_name": "Guerrero",
            "state": "TX",
            "email": "guerreropaul6@gmail.com",
            "status": "Funded",
            "tracking_tokens": []
        },
        {
            "uuid": "00020984-b812-4d99-a2cc-70684dc59b9f",
            "token": null,
            "business_name": "Repair Hub",
            "first_name": "Paul",
            "last_name": "Guerrero",
            "state": "TX",
            "email": "guerreropaul6@gmail.com",
            "status": "Funded",
            "tracking_tokens": []
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "/",
        "per_page": "10",
        "to": 2,
        "total": 2
    }
}

Received response:

Request failed with error:

Retrieve Single Application

Requires Authentication

This endpoint, allows registered users, to retrieve single application providing its uuid.

GET api/v1/deals/{application}

Use the following command

curl --request GET \
    --get "https://api.lendflow.com/api/v1/deals/317fdf56-cc6d-4856-bde5-0bcb2e79b41e" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

The above command returns JSON structured like this:


{
    "data": {
        "uuid": "00020984-b812-4d99-a2cc-70684dc59b9f",
        "token": null,
        "business_name": "Repair Hub",
        "first_name": "Paul",
        "last_name": "Guerrero",
        "state": "TX",
        "email": "guerreropaul6@gmail.com",
        "status": "Funded",
        "tracking_tokens": []
    }
}

Received response:

Request failed with error:

4. Application Offers

Legacy API endpoints

Get all Offers

Requires Authentication

This endpoint, allows registered users, to retrieve offers

GET api/v1/offers

Use the following command

curl --request GET \
    --get "https://api.lendflow.com/api/v1/offers" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

The above command returns JSON structured like this:


{
    "data": [
        {
            "businesslegalname": "Roche Lawn Service",
            "deal": "c122ad47-8af9-4604-8924-f9fa55a3590a",
            "date_offer": "2021-11-18T18:55:32.000000Z",
            "name": null,
            "credit_available": null,
            "discount_rate_10days": null,
            "discount_rate_month": null,
            "term": null,
            "term_length": null,
            "offer_amount": null,
            "min_sell_factor_rate": null
        },
        {
            "businesslegalname": "Roche Lawn Service",
            "deal": "c122ad47-8af9-4604-8924-f9fa55a3590a",
            "date_offer": "2021-11-18T18:55:32.000000Z",
            "name": null,
            "credit_available": null,
            "discount_rate_10days": null,
            "discount_rate_month": null,
            "term": null,
            "term_length": null,
            "offer_amount": null,
            "min_sell_factor_rate": null
        }
    ]
}

Received response:

Request failed with error:

5. Business Credit Application

Legacy API endpoints

Apply for Business Credit

Requires Authentication

POST api/v1/applications/business_credit

Use the following command

curl --request POST \
    "https://api.lendflow.com/api/v1/applications/business_credit" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "basic_info[first_name]=John" \
    --form "basic_info[last_name]=Doe" \
    --form "basic_info[email_address]=john@doe.com" \
    --form "basic_info[telephone]=2025550152" \
    --form "basic_info[doing_business_as]=CEO" \
    --form "basic_info[date_of_birth]=1990-05-26" \
    --form "business_address[address_line]=20 Hudson Yards" \
    --form "business_address[address_line2]=" \
    --form "business_address[city]=New York" \
    --form "business_address[state]=NY" \
    --form "business_address[country]=US" \
    --form "business_address[zip]=10001" \
    --form "business_start_date=2001-05-26" \
    --form "business_entity=business_entity_type_1" \
    --form "business_legal_name=John Doe LLC" \
    --form "employee_identification_number=123456789" \
    --form "social_security_number=123456789" \
    --form "individual_taxpayer_identification_number=987654321" \
    --form "terms_of_service=" \
    --form "requested_products[]=heron" \
    --form "plaid_data[accounts][][mask]=0000" \
    --form "plaid_data[accounts][][name]=Plaid Checking" \
    --form "plaid_data[accounts][][type]=depository" \
    --form "plaid_data[accounts][][subtype]=checking" \
    --form "plaid_data[accounts][][balances][limit]=" \
    --form "plaid_data[accounts][][balances][current]=110" \
    --form "plaid_data[accounts][][balances][available]=100" \
    --form "plaid_data[accounts][][balances][iso_currency_code]=USD" \
    --form "plaid_data[accounts][][balances][unofficial_currency_code]=" \
    --form "plaid_data[accounts][][account_id]=8r8K5P6NlXIQqJLB8w8nfLGPmj8Q8MFwG5aGk" \
    --form "plaid_data[accounts][][official_name]=Plaid Gold Standard 0% Interest Checking" \
    --form "plaid_data[transactions][][date]=2021-04-12" \
    --form "plaid_data[transactions][][name]=United Airlines" \
    --form "plaid_data[transactions][][amount]=220.42" \
    --form "plaid_data[transactions][][pending]=" \
    --form "plaid_data[transactions][][category][]=Travel" \
    --form "plaid_data[transactions][][location][lat]=" \
    --form "plaid_data[transactions][][location][lon]=" \
    --form "plaid_data[transactions][][location][city]=" \
    --form "plaid_data[transactions][][location][region]=" \
    --form "plaid_data[transactions][][location][address]=" \
    --form "plaid_data[transactions][][location][country]=" \
    --form "plaid_data[transactions][][location][postal_code]=" \
    --form "plaid_data[transactions][][location][store_number]=" \
    --form "plaid_data[transactions][][account_id]=EQgePW78jXTZ9x7EmkmVhR9DpZl6lkuX1zQ1W" \
    --form "plaid_data[transactions][][category_id]=22001000" \
    --form "plaid_data[transactions][][payment_meta][payee]=" \
    --form "plaid_data[transactions][][payment_meta][payer]=" \
    --form "plaid_data[transactions][][payment_meta][ppd_id]=" \
    --form "plaid_data[transactions][][payment_meta][reason]=" \
    --form "plaid_data[transactions][][payment_meta][by_order_of]=" \
    --form "plaid_data[transactions][][payment_meta][payment_method]=" \
    --form "plaid_data[transactions][][payment_meta][reference_number]=" \
    --form "plaid_data[transactions][][payment_meta][payment_processor]=" \
    --form "plaid_data[transactions][][account_owner]=" \
    --form "plaid_data[transactions][][merchant_name]=United Airlines" \
    --form "plaid_data[transactions][][transaction_id]=pBdwjmgq14H9jVg1WEWDiMdRjRBAKzILWegNa" \
    --form "plaid_data[transactions][][authorized_date]=" \
    --form "plaid_data[transactions][][payment_channel]=in store" \
    --form "plaid_data[transactions][][transaction_code]=" \
    --form "plaid_data[transactions][][transaction_type]=special" \
    --form "plaid_data[transactions][][iso_currency_code]=USD" \
    --form "plaid_data[transactions][][pending_transaction_id]=" \
    --form "plaid_data[transactions][][unofficial_currency_code]=" \
    --form "plaid_data[total_transactions]=16" \
    --form "client_tracking_token=vmqeopfuudtdsufvyvddqamniihfqcoynlazghdtq" \
    --form "tracking_tokens[]=" \
    --form "bank_statements[][type]=bank_statements_4" \
    --form "personal_address[address_line]=20 Hudson Yards" \
    --form "personal_address[address_line2]=" \
    --form "personal_address[city]=New York" \
    --form "personal_address[state]=NY" \
    --form "personal_address[country]=US" \
    --form "personal_address[zip]=10001" \
    --form "bank_statements[][file]=@/tmp/phpizQ8Lr"

The above command returns JSON structured like this:


{
    "application_id": "XXXX"
}

Received response:

Request failed with error:

Body Parameters

basic_info object optional

basic_info.first_name string

basic_info.last_name string

basic_info.email_address string

Must be a valid email address.

basic_info.telephone string

basic_info.doing_business_as string optional

basic_info.date_of_birth string optional

Must be a valid date in the format Y-m-d.

business_address object optional

business_address.address_line string

business_address.address_line2 string optional

business_address.city string

Must not be greater than 50 characters.

business_address.state string

Two-letter state code.

business_address.country string

Two-letter country code.

business_address.zip string

Must be between 5-9 digits. Must not be greater than 50 characters.

business_start_date string

Business start date using format YYYY-MM-DD . Must be a valid date in the format Y-m-d.

business_entity string

The value must be one of:
business_entity_type_1 (LLC)
business_entity_type_2 (Sole Proprietorship)
business_entity_type_3 (Partnership)
business_entity_type_4 (Corporation)
business_entity_type_41 (Cooperative)
business_entity_type_5 (Non-profit)
business_entity_type_6 (I’m not sure)
business_entity_type_7 (I haven’t registered it yet).

business_legal_name string

employee_identification_number string optional

social_security_number string optional

individual_taxpayer_identification_number string optional

terms_of_service boolean

Do you accept our terms of service.

requested_products string[] optional

Must be one of ekata, experian_uccs, experian_bankruptcies, experian_judgments, experian_liens, experian_intelliscore, experian_fsr, experian_commercial_collections, experian_credit_status, experian_legal_collections, experian_trades, experian_corporate_registrations, experian_business_contacts, experian_business_facts, experian_fraud_shields, dnb_cer_l1, dnb_ci_l2, dnb_pi_l3, dnb_fi_l2, dnb_fi_l3, dnb_fi_l4, dnb_dti_l1, middesk, heron, persona, scorely, sentilink, or ocrolus_cfa.

plaid_data string[] optional

Plaid JSON from transactions/get.

client_tracking_token string optional

Must not be greater than 50 characters.

tracking_tokens string[] optional

bank_statements object[] optional

bank_statements[].file file optional

A bank statement. Must be a PDF, JPG, PNG, BMP, or GIF. This field is required when bank_statements is present. Must be a file. Must not be greater than 51200 kilobytes.

bank_statements[].type string optional

Identifier for the type of bank statement provided. The value must be one of:
bank_statements_1 (Bank statement for January)
bank_statements_2 (Bank statement for February)
bank_statements_3 (Bank statement for March)
bank_statements_4 (Bank statement for April)
bank_statements_5 (Bank statement for May)
bank_statements_6 (Bank statement for June)
bank_statements_7 (Bank statement for July)
bank_statements_8 (Bank statement for August)
bank_statements_9 (Bank statement for September)
bank_statements_10 (Bank statement for October)
bank_statements_11 (Bank statement for November)
bank_statements_12 (Bank statement for December). This field is required when bank_statements is present. Must be one of bank_statements_1, bank_statements_2, bank_statements_3, bank_statements_4, bank_statements_5, bank_statements_6, bank_statements_7, bank_statements_8, bank_statements_9, bank_statements_10, bank_statements_11, or bank_statements_12.

personal_address object optional

personal_address.address_line string optional

This field is required when personal_address is present.

personal_address.address_line2 string optional

personal_address.city string optional

This field is required when personal_address is present. Must not be greater than 50 characters.

personal_address.state string optional

This field is required when personal_address is present.

personal_address.country string optional

Two-letter country code. This field is required when personal_address is present.

personal_address.zip string optional

Must be between 5-9 digits. This field is required when personal_address is present. Must not be greater than 50 characters.

Enrich Business Credit Application

Requires Authentication

PUT api/v1/applications/business_credit/{application}/enrich

Use the following command

curl --request PUT \
    "https://api.lendflow.com/api/v1/applications/business_credit/317fdf56-cc6d-4856-bde5-0bcb2e79b41e/enrich" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "basic_info[first_name]=John" \
    --form "basic_info[last_name]=Doe" \
    --form "basic_info[email_address]=john@doe.com" \
    --form "basic_info[telephone]=2025550152" \
    --form "basic_info[doing_business_as]=CEO" \
    --form "basic_info[date_of_birth]=1990-05-26" \
    --form "business_address[address_line]=20 Hudson Yards" \
    --form "business_address[address_line2]=" \
    --form "business_address[city]=New York" \
    --form "business_address[state]=NY" \
    --form "business_address[country]=US" \
    --form "business_address[zip]=10001" \
    --form "business_start_date=2001-05-26" \
    --form "business_entity=business_entity_type_1" \
    --form "business_legal_name=John Doe LLC" \
    --form "employee_identification_number=123456789" \
    --form "social_security_number=123456789" \
    --form "individual_taxpayer_identification_number=987654321" \
    --form "requested_products[]=experian_commercial_collections" \
    --form "plaid_data[accounts][][mask]=0000" \
    --form "plaid_data[accounts][][name]=Plaid Checking" \
    --form "plaid_data[accounts][][type]=depository" \
    --form "plaid_data[accounts][][subtype]=checking" \
    --form "plaid_data[accounts][][balances][limit]=" \
    --form "plaid_data[accounts][][balances][current]=110" \
    --form "plaid_data[accounts][][balances][available]=100" \
    --form "plaid_data[accounts][][balances][iso_currency_code]=USD" \
    --form "plaid_data[accounts][][balances][unofficial_currency_code]=" \
    --form "plaid_data[accounts][][account_id]=8r8K5P6NlXIQqJLB8w8nfLGPmj8Q8MFwG5aGk" \
    --form "plaid_data[accounts][][official_name]=Plaid Gold Standard 0% Interest Checking" \
    --form "plaid_data[transactions][][date]=2021-04-12" \
    --form "plaid_data[transactions][][name]=United Airlines" \
    --form "plaid_data[transactions][][amount]=220.42" \
    --form "plaid_data[transactions][][pending]=" \
    --form "plaid_data[transactions][][category][]=Travel" \
    --form "plaid_data[transactions][][location][lat]=" \
    --form "plaid_data[transactions][][location][lon]=" \
    --form "plaid_data[transactions][][location][city]=" \
    --form "plaid_data[transactions][][location][region]=" \
    --form "plaid_data[transactions][][location][address]=" \
    --form "plaid_data[transactions][][location][country]=" \
    --form "plaid_data[transactions][][location][postal_code]=" \
    --form "plaid_data[transactions][][location][store_number]=" \
    --form "plaid_data[transactions][][account_id]=EQgePW78jXTZ9x7EmkmVhR9DpZl6lkuX1zQ1W" \
    --form "plaid_data[transactions][][category_id]=22001000" \
    --form "plaid_data[transactions][][payment_meta][payee]=" \
    --form "plaid_data[transactions][][payment_meta][payer]=" \
    --form "plaid_data[transactions][][payment_meta][ppd_id]=" \
    --form "plaid_data[transactions][][payment_meta][reason]=" \
    --form "plaid_data[transactions][][payment_meta][by_order_of]=" \
    --form "plaid_data[transactions][][payment_meta][payment_method]=" \
    --form "plaid_data[transactions][][payment_meta][reference_number]=" \
    --form "plaid_data[transactions][][payment_meta][payment_processor]=" \
    --form "plaid_data[transactions][][account_owner]=" \
    --form "plaid_data[transactions][][merchant_name]=United Airlines" \
    --form "plaid_data[transactions][][transaction_id]=pBdwjmgq14H9jVg1WEWDiMdRjRBAKzILWegNa" \
    --form "plaid_data[transactions][][authorized_date]=" \
    --form "plaid_data[transactions][][payment_channel]=in store" \
    --form "plaid_data[transactions][][transaction_code]=" \
    --form "plaid_data[transactions][][transaction_type]=special" \
    --form "plaid_data[transactions][][iso_currency_code]=USD" \
    --form "plaid_data[transactions][][pending_transaction_id]=" \
    --form "plaid_data[transactions][][unofficial_currency_code]=" \
    --form "plaid_data[total_transactions]=16" \
    --form "bank_statements[][type]=bank_statements_4" \
    --form "bank_statements[][file]=@/tmp/phpGOfplq"

The above command returns JSON structured like this:


{
    "enrichment_started": true
}

Received response:

Request failed with error:

URL Parameters

application string

Application uuid.

Body Parameters

basic_info object optional

basic_info.first_name string optional

basic_info.last_name string optional

basic_info.email_address string optional

Must be a valid email address.

basic_info.telephone string optional

basic_info.doing_business_as string optional

basic_info.date_of_birth string optional

Must be a valid date in the format Y-m-d.

business_address object optional

business_address.address_line string optional

business_address.address_line2 string optional

business_address.city string optional

business_address.state string optional

Two-letter state code.

business_address.country string optional

Two-letter country code.

business_address.zip string optional

Must be between 5-9 digits.

business_start_date string optional

Business start date using format YYYY-MM-DD . Must be a valid date in the format Y-m-d.

business_entity string optional

business_legal_name string optional

employee_identification_number string optional

social_security_number string optional

individual_taxpayer_identification_number string optional

requested_products string[]

plaid_data string[] optional

Plaid JSON from transactions/get.

bank_statements object[] optional

bank_statements[].file file optional

A bank statement. Must be a PDF, JPG, PNG, BMP, or GIF. This field is required when bank_statements is present. Must be a file. Must not be greater than 51200 kilobytes.

bank_statements[].type string optional

Create Document Verification

Requires Authentication

Verify a document against a 3rd party service. Currently supports Persona's government ID verification.

The service ("persona") and verification at that service ("government-id") must be specified, along with all attributes needed to satisfy the verification.

For Persona's Government ID verification the following additional request parameters are required:

type
front_photo
back_photo (this is optional, but helps with verification)

POST api/v1/applications/business_credit/{application}/verify-documents

Use the following command

curl --request POST \
    "https://api.lendflow.com/api/v1/applications/business_credit/317fdf56-cc6d-4856-bde5-0bcb2e79b41e/verify-documents" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "service=persona" \
    --form "personal_information_id=17" \
    --form "verification=government-id" \
    --form "type=dl" \
    --form "front_photo=@/tmp/phpP38BUp" \
    --form "back_photo=@/tmp/phpvE88Yp"

The above command returns JSON structured like this:


{
    "data": {
        "id": 4,
        "service": "persona",
        "verification": "government-id",
        "created_at": "2021-07-05T07:51:10.000000Z",
        "updated_at": "2021-07-05T07:51:21.000000Z",
        "submitted_at": "2021-07-05 07:51:10",
        "passed_at": null,
        "failed_at": "2021-07-05T07:51:21.000000Z",
        "has_passed": false,
        "has_failed": true
    }
}

Received response:

Request failed with error:

URL Parameters

application string

Application uuid.

Body Parameters

service string

A supported verification service identifier.

personal_information_id integer optional

The ID of the personal information record (business owner) the verification should be tied to.

verification string

A verification to perform against the service.

type string optional

The type of ID to verify. Must be "pp" (passport), "dl" (driver's license), or "id" (other government ID).

front_photo file optional

A picture of the front of the ID. Must be of type jpg, png, heic, or pdf.

back_photo file optional

A picture of the back of the ID. Must be of type jpg, png, heic, or pdf.

Pull Application Commercial Data

Requires Authentication

This endpoint, allows registered users, to pull commercial data on any given applicant.

GET api/v1/deal/{application}/commercial

Use the following command

curl --request GET \
    --get "https://api.lendflow.com/api/v1/deal/317fdf56-cc6d-4856-bde5-0bcb2e79b41e/commercial?raw_cfa=" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

The above command returns JSON structured like this:


{
    "data": {
        "uuid": "00020984-b812-4d99-a2cc-70684dc59b9f",
        "business_legal_name": "Repair Hub",
        "dates": [],
        "statuses": {
            "middesk": "Not yet started",
            "sentilink": "Not yet started",
            "dnb": {
                "cer_l1": "Not yet started",
                "ci_l2": "Not yet started",
                "pi_l3": "Not yet started",
                "fi_l2": "Not yet started",
                "fi_l3": "Not yet started",
                "fi_l4": "Not yet started",
                "dti_l1": "Not yet started"
            },
            "experian": {
                "intelliscore": "Not yet started",
                "uccs": "Not yet started",
                "bankruptcies": "Not yet started",
                "judgments": "Not yet started",
                "liens": "Not yet started",
                "fsr": "Not yet started",
                "commercial_collections": "Not yet started",
                "credit_statuses": "Not yet started",
                "legal_collections": "Not yet started",
                "trades": "Not yet started",
                "corporate_registrations": "Not yet started",
                "contacts": "Not yet started",
                "facts": "Not yet started",
                "fraud_shields": "Not yet started"
            },
            "ocrolus_cfa": "Not yet started",
            "ekata": "Not yet started",
            "heron": "Not yet started",
            "scorely": "Not yet started"
        },
        "commercial_data": {
            "middesk": null,
            "sentilink": null,
            "experian": {
                "intelliscore": null,
                "uccs": null,
                "bankruptcies": null,
                "judgments": null,
                "liens": null,
                "fsr": null,
                "commercial_collections": null,
                "credit_statuses": null,
                "legal_collections": null,
                "trades": null,
                "corporate_registrations": null,
                "contacts": null,
                "facts": null,
                "fraud_shields": null
            },
            "dnb": {
                "assessment": null,
                "duns": null,
                "primary_name": null,
                "number_of_employees": null,
                "business_trading": null,
                "cer_l1": null,
                "fi_l2": null,
                "fi_l3": null,
                "dti_l1": null
            },
            "scorely": null,
            "ekata": null,
            "heron": {
                "pnl": null,
                "pnl_transactions": null
            }
        }
    }
}

Received response:

Request failed with error:

6. Advanced Integrations

Generate Plaid and Docusign links

Requires Authentication

This endpoint generates the Docusign link and the Plaid link_code.

GET api/v2/applications/{application}/links

Use the following command

curl --request GET \
    --get "https://api.lendflow.com/api/v2/applications/317fdf56-cc6d-4856-bde5-0bcb2e79b41e/links" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

The above command returns JSON structured like this:


{
    "data": {
        "plaid_link_token": "link-sandbox-cf19d9f3-20af-4fd8-bc52-0fff9214bfa2",
        "docusign_link": "https://demo.docusign.net/Signing/MTRedeem/v1/a9e40afa-808c-483f-9ad8-a74a80bbe303?slt=eyJ0eXAiOiJNVCIsImFsZyI6IlJTMjU2Iiwia2lkIjoiNjgxODVmZjEtNGU1MS00Y2U5LWFmMWMtNjg5ODEyMjAzMzE3In0.AQUAAAABAAMABwAAfKOT_ynZSAgAANpzRgAq2UgYAAEAAAAAAAAAIQCCAgAAeyJUb2tlbklkIjoiYzMyZjkwZDAtOGYyMy00MzZhLWFlNTctN2Q1MDgxZGRkZjAxIiwiRXhwaXJhdGlvbiI6IjIwMjEtMDYtMDdUMjI6MDQ6NTIrMDA6MDAiLCJJc3N1ZWRBdCI6IjIwMjEtMDYtMDdUMjE6NTk6NTIuOTI2NzkzOCswMDowMCIsIlJlc291cmNlSWQiOiJjMDEzZTUxOC1hYzQ4LTQyZjItODVlNi1kZGQ3ZmFlMzM1NzgiLCJSZXNvdXJjZXMiOiJ7XCJFbnZlbG9wZUlkXCI6XCJjMDEzZTUxOC1hYzQ4LTQyZjItODVlNi1kZGQ3ZmFlMzM1NzhcIixcIkFjdG9yVXNlcklkXCI6XCJjYjM0NGM1Ny04OGQ3LTQwOTktYWFkOS1lODlhMzE2MzBjOWVcIixcIlJlY2lwaWVudElkXCI6XCI3NDRlNjVhMi00YTY0LTRlYjktOGI0MC0yNzg0NGQyZTVkNWNcIixcIkZha2VRdWVyeVN0cmluZ1wiOlwidD05NDhkMzRiYi0xNDQ5LTRlNmQtOTA1MS05Y2U2ODFiYTM1YTdcIn0iLCJUb2tlblR5cGUiOjEsIkF1ZGllbmNlIjoiMjVlMDkzOTgtMDM0NC00OTBjLThlNTMtM2FiMmNhNTYyN2JmIiwiUmVkaXJlY3RVcmkiOiJodHRwczovL2RlbW8uZG9jdXNpZ24ubmV0L1NpZ25pbmcvU3RhcnRJblNlc3Npb24uYXNweCIsIkhhc2hBbGdvcml0aG0iOjAsIkhhc2hSb3VuZHMiOjAsIlRva2VuU3RhdHVzIjowLCJJc1NpbmdsZVVzZSI6ZmFsc2V9.TOiEEZjMJ9mDVCVaGDcTdGb979uXosaZ5X2O3D2e6W2EuEzOH29m55m-3T2dhquGzNAZAELShnQ8ynAsn7B4Xl8hv-0UpbQwLNTrEvgCcQVXc6WrtBDU1N6yXoX0Yf1nKbszgGCVbAhbagQ337zp95PXevFoF4Qn9_4z2w-VneBhgHwQ6N7XgGWEZNKLW3-4IR6dyhodOUTdKThIlcqUSpmaTS6Vco7yYfQidWgcCkjdYjfsxRS_r0O4Kv709ptpEPO_uCoDNaoyBNqqOLMMR00ZBo2lXLzv08d6ySY79O-NJOy0t8S_MN7Bf24ZRy1ueLNEwaMlYeo22vF7u5K4uw"
    }
}

Received response:

Request failed with error:

Update Lendflow Plaid records

Requires Authentication

This endpoint informs Lendflow that the Plaid information has been linked and is ready to process.

POST api/v2/applications/{application}/plaid

Use the following command

curl --request POST \
    "https://api.lendflow.com/api/v2/applications/317fdf56-cc6d-4856-bde5-0bcb2e79b41e/plaid" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"plaid_token\": \"access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6\"
}"

The above command returns JSON structured like this:


{
    "data": {
        "success": true
    }
}

Received response:

Request failed with error:

Finish application processing

Requires Authentication

This endpoint informs Lendflow that the documents are signed and Plaid is connected. This will finalize the application process.

POST api/v2/applications/{application}/finish

Use the following command

curl --request POST \
    "https://api.lendflow.com/api/v2/applications/317fdf56-cc6d-4856-bde5-0bcb2e79b41e/finish" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"1\",
    \"requested_products\": [
        \"experian_corporate_registrations\",
        \"experian_fraud_shields\"
    ],
    \"notify\": 17
}"

The above command returns JSON structured like this:


{
    "data": {
        "success": true
    }
}

The above command returns JSON structured like this:


{
    "message": "Document is not signed",
    "errors": {
        "application": [
            "Document is not signed"
        ]
    }
}

Received response:

Request failed with error:

URL Parameters

application string

Application uuid.

Body Parameters

type string

Must be one of 1, 2, 3, 4, 5, or 6.

requested_products string[] optional

notify integer optional

7. NextGen

NextGen API endpoints

Save prequalification record

Requires Authentication

POST api/v2/prequalification

Use the following command

curl --request POST \
    "https://api.lendflow.com/api/v2/prequalification" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"time_in_business\": \"time_in_business_1\",
    \"monthly_avg_revenue\": \"monthly_avg_revenue_1\",
    \"credit_score\": \"credit_score_1\",
    \"requested_amount\": 11613.31890586
}"

The above command returns JSON structured like this:


{
    "data": {
        "prequalification_amount_min": 60000,
        "prequalification_amount_max": 140000,
        "prequalification_id": "0000af4e-1150-4097-97ec-1329d78177ff",
        "time_in_business": "time_in_business_1",
        "monthly_avg_revenue": "monthly_avg_revenue_8",
        "credit_score": "credit_score_4",
        "requested_amount": 150000,
        "currency": "USD"
    }
}

Received response:

Request failed with error:

Body Parameters

time_in_business string

time_in_business_1, time_in_business_2, time_in_business_3, time_in_business_4, time_in_business_5, time_in_business_6, time_in_business_7, time_in_business_8.

monthly_avg_revenue string

monthly_avg_revenue_1, monthly_avg_revenue_2, monthly_avg_revenue_3, monthly_avg_revenue_4, monthly_avg_revenue_5, monthly_avg_revenue_6, monthly_avg_revenue_7, monthly_avg_revenue_8, monthly_avg_revenue_9, monthly_avg_revenue_10, monthly_avg_revenue_11, monthly_avg_revenue_12.

credit_score string

credit_score_1, credit_score_2, credit_score_3, credit_score_4, credit_score_5, credit_score_6, credit_score_7, credit_score_8.

currency string optional

requested_amount number

Create Application From Pre-Qualification

Requires Authentication

POST api/v2/application

Use the following command

curl --request POST \
    "https://api.lendflow.com/api/v2/application" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"John\",
    \"last_name\": \"Doe\",
    \"email_address\": \"qkunze@example.com\",
    \"telephone\": \"212555555\",
    \"business_legal_name\": \"Example inc.\",
    \"prequalification_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"client_tracking_token\": \"vmqeopfuudtdsufvyvddqamniihfqcoynlazghdtq\",
    \"tracking_tokens\": [
        null
    ]
}"

The above command returns JSON structured like this:


{
    "data": {
        "id": "00020984-b812-4d99-a2cc-70684dc59b9f",
        "client_tracking_token": null,
        "status": 5,
        "sub_status": null,
        "closing_status_id": null,
        "progress": 100,
        "declined_reason": null,
        "declined_prev_status": null,
        "declined_sub_reason": null,
        "declined_at": null,
        "use_of_fund_id": 3,
        "funds_needed_time_id": null,
        "is_business_credit": false,
        "is_equipment_rental": false,
        "finished_type": 1,
        "finished_at": null,
        "amount_needed": null,
        "referrer_url": null,
        "source": 2,
        "underwriter_review_needed": false,
        "naics_code": "811212",
        "industry": null,
        "business_notes": "{\"client_comment\":\"https:\\/\\/www.repairhubtx.com\\/\\r\\n\\r\\nRepair Hub is Brownsville's premier smartphone repair outfit with 2 stellar locations. They specialize in the immediate professional repair of mobile phones, smartphones and tablets for many manufacturers. \\r\\n\\r\\nMerchant is looking for $125k for larger lots of inventory as they continue to increase their sales quarter after quarter and aim to open a 3rd store in west Texas by the end of the year. Timeline for funds requested is by the end of the month and they have no current outstanding loans .\"}",
        "created_at": "2021-01-15T20:07:57.000000Z",
        "offers_declined_feedback": null,
        "offers_declined_at": null,
        "offer_count": 1,
        "stage": "LFW_25",
        "is_client_funded": false,
        "tracking_tokens": []
    }
}

Received response:

Request failed with error:

Body Parameters

first_name string

last_name string

email_address string

Must be a valid email address.

telephone string

business_legal_name string

doing_business_as string optional

prequalification_id string

Must be a valid UUID.

client_tracking_token string optional

Must not be greater than 50 characters.

tracking_tokens string[] optional

business_zip string optional

owner_zip string optional

Create Application With Plaid

Requires Authentication

POST api/v2/application/plaid

Use the following command

curl --request POST \
    "https://api.lendflow.com/api/v2/application/plaid" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"John\",
    \"last_name\": \"Doe\",
    \"email_address\": \"qkunze@example.com\",
    \"telephone\": \"212555555\",
    \"business_legal_name\": \"Example inc.\",
    \"client_tracking_token\": \"vmqeopfuudtdsufvyvddqamniihfqcoynlazghdtq\",
    \"tracking_tokens\": [
        null
    ],
    \"plaid_data\": [
        \"consequatur\"
    ]
}"

The above command returns JSON structured like this:


{
    "data": {
        "id": "00020984-b812-4d99-a2cc-70684dc59b9f",
        "client_tracking_token": null,
        "status": 5,
        "sub_status": null,
        "closing_status_id": null,
        "progress": 100,
        "declined_reason": null,
        "declined_prev_status": null,
        "declined_sub_reason": null,
        "declined_at": null,
        "use_of_fund_id": 3,
        "funds_needed_time_id": null,
        "is_business_credit": false,
        "is_equipment_rental": false,
        "finished_type": 1,
        "finished_at": null,
        "amount_needed": null,
        "referrer_url": null,
        "source": 2,
        "underwriter_review_needed": false,
        "naics_code": "811212",
        "industry": null,
        "business_notes": "{\"client_comment\":\"https:\\/\\/www.repairhubtx.com\\/\\r\\n\\r\\nRepair Hub is Brownsville's premier smartphone repair outfit with 2 stellar locations. They specialize in the immediate professional repair of mobile phones, smartphones and tablets for many manufacturers. \\r\\n\\r\\nMerchant is looking for $125k for larger lots of inventory as they continue to increase their sales quarter after quarter and aim to open a 3rd store in west Texas by the end of the year. Timeline for funds requested is by the end of the month and they have no current outstanding loans .\"}",
        "created_at": "2021-01-15T20:07:57.000000Z",
        "offers_declined_feedback": null,
        "offers_declined_at": null,
        "offer_count": 1,
        "stage": "LFW_25",
        "is_client_funded": false,
        "tracking_tokens": []
    }
}

Received response:

Request failed with error:

Body Parameters

first_name string

last_name string

email_address string

Must be a valid email address.

telephone string

business_legal_name string

doing_business_as string optional

client_tracking_token string optional

Must not be greater than 50 characters.

tracking_tokens string[] optional

business_zip string optional

owner_zip string optional

plaid_data string[]

Retrieve single Application details

Requires Authentication

This endpoint will return an application's details, matching by Lendflow's internal application UUID or the first application matching a client's tracking token.

GET api/v2/applications/{id}

Use the following command

curl --request GET \
    --get "https://api.lendflow.com/api/v2/applications/317fdf56-cc6d-4856-bde5-0bcb2e79b41e" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

The above command returns JSON structured like this:


{
    "data": {
        "id": "00020984-b812-4d99-a2cc-70684dc59b9f",
        "client_tracking_token": null,
        "status": 5,
        "sub_status": null,
        "closing_status_id": null,
        "progress": 100,
        "declined_reason": null,
        "declined_prev_status": null,
        "declined_sub_reason": null,
        "declined_at": null,
        "use_of_fund_id": 3,
        "funds_needed_time_id": null,
        "is_business_credit": false,
        "is_equipment_rental": false,
        "finished_type": 1,
        "finished_at": null,
        "amount_needed": null,
        "referrer_url": null,
        "source": 2,
        "underwriter_review_needed": false,
        "naics_code": "811212",
        "industry": null,
        "business_notes": "{\"client_comment\":\"https:\\/\\/www.repairhubtx.com\\/\\r\\n\\r\\nRepair Hub is Brownsville's premier smartphone repair outfit with 2 stellar locations. They specialize in the immediate professional repair of mobile phones, smartphones and tablets for many manufacturers. \\r\\n\\r\\nMerchant is looking for $125k for larger lots of inventory as they continue to increase their sales quarter after quarter and aim to open a 3rd store in west Texas by the end of the year. Timeline for funds requested is by the end of the month and they have no current outstanding loans .\"}",
        "created_at": "2021-01-15T20:07:57.000000Z",
        "offers_declined_feedback": null,
        "offers_declined_at": null,
        "offer_count": 1,
        "stage": "LFW_25",
        "is_client_funded": false,
        "tracking_tokens": []
    }
}

Received response:

Request failed with error:

Retrieve Applications

Requires Authentication

This endpoint, allows registered users, to retrieve all applications that have been submitted through the integration widget and/or api.

GET api/v2/applications

Use the following command

curl --request GET \
    --get "https://api.lendflow.com/api/v2/applications" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

The above command returns JSON structured like this:


{
    "data": [
        {
            "id": "00020984-b812-4d99-a2cc-70684dc59b9f",
            "client_tracking_token": null,
            "status": 5,
            "sub_status": null,
            "closing_status_id": null,
            "progress": 100,
            "declined_reason": null,
            "declined_prev_status": null,
            "declined_sub_reason": null,
            "declined_at": null,
            "use_of_fund_id": 3,
            "funds_needed_time_id": null,
            "is_business_credit": false,
            "is_equipment_rental": false,
            "finished_type": 1,
            "finished_at": null,
            "amount_needed": null,
            "referrer_url": null,
            "source": 2,
            "underwriter_review_needed": false,
            "naics_code": "811212",
            "industry": null,
            "business_notes": "{\"client_comment\":\"https:\\/\\/www.repairhubtx.com\\/\\r\\n\\r\\nRepair Hub is Brownsville's premier smartphone repair outfit with 2 stellar locations. They specialize in the immediate professional repair of mobile phones, smartphones and tablets for many manufacturers. \\r\\n\\r\\nMerchant is looking for $125k for larger lots of inventory as they continue to increase their sales quarter after quarter and aim to open a 3rd store in west Texas by the end of the year. Timeline for funds requested is by the end of the month and they have no current outstanding loans .\"}",
            "created_at": "2021-01-15T20:07:57.000000Z",
            "offers_declined_feedback": null,
            "offers_declined_at": null,
            "offer_count": 1,
            "stage": "LFW_25",
            "is_client_funded": false,
            "tracking_tokens": []
        },
        {
            "id": "00020984-b812-4d99-a2cc-70684dc59b9f",
            "client_tracking_token": null,
            "status": 5,
            "sub_status": null,
            "closing_status_id": null,
            "progress": 100,
            "declined_reason": null,
            "declined_prev_status": null,
            "declined_sub_reason": null,
            "declined_at": null,
            "use_of_fund_id": 3,
            "funds_needed_time_id": null,
            "is_business_credit": false,
            "is_equipment_rental": false,
            "finished_type": 1,
            "finished_at": null,
            "amount_needed": null,
            "referrer_url": null,
            "source": 2,
            "underwriter_review_needed": false,
            "naics_code": "811212",
            "industry": null,
            "business_notes": "{\"client_comment\":\"https:\\/\\/www.repairhubtx.com\\/\\r\\n\\r\\nRepair Hub is Brownsville's premier smartphone repair outfit with 2 stellar locations. They specialize in the immediate professional repair of mobile phones, smartphones and tablets for many manufacturers. \\r\\n\\r\\nMerchant is looking for $125k for larger lots of inventory as they continue to increase their sales quarter after quarter and aim to open a 3rd store in west Texas by the end of the year. Timeline for funds requested is by the end of the month and they have no current outstanding loans .\"}",
            "created_at": "2021-01-15T20:07:57.000000Z",
            "offers_declined_feedback": null,
            "offers_declined_at": null,
            "offer_count": 1,
            "stage": "LFW_25",
            "is_client_funded": false,
            "tracking_tokens": []
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "/",
        "per_page": "15",
        "to": 2,
        "total": 2
    }
}

Received response:

Request failed with error:

Add Application Metadata

Requires Authentication

Further enrich an application by passing valid JSON to be stored as metadata.

Multiple requests can be made to this endpoint to attach multiple pieces of metadata to the same application.

POST api/v2/applications/{application}/metadata

Use the following command

curl --request POST \
    "https://api.lendflow.com/api/v2/applications/317fdf56-cc6d-4856-bde5-0bcb2e79b41e/metadata" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"metadata\": {
        \"key\": \"value\"
    },
    \"description\": \"Example text\"
}"

The above command returns JSON structured like this:


{
    "data": {
        "id": 33,
        "description": "A small metadata sample",
        "metadata": {
            "sample": "value"
        },
        "created_at": "2021-07-08T16:28:07.000000Z",
        "updated_at": "2021-07-08T16:28:07.000000Z"
    }
}

The above command returns JSON structured like this:


{
    "data": {
        "id": 2,
        "description": "w9",
        "metadata": null,
        "created_at": "2021-04-29T14:07:30.000000Z",
        "updated_at": "2021-04-29T14:07:30.000000Z"
    }
}

Received response:

Request failed with error:

Save Personal Address

Requires Authentication

PUT api/v2/applications/{application}/personal_address

Use the following command

curl --request PUT \
    "https://api.lendflow.com/api/v2/applications/317fdf56-cc6d-4856-bde5-0bcb2e79b41e/personal_address" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"is_home_business\": false,
    \"is_sole_owner\": false,
    \"job_title\": \"CEO\",
    \"owner_percentage\": 81,
    \"business_start_date\": \"2021-12-03\",
    \"personal_address\": \"24th Street\",
    \"personal_address_2\": \"123\",
    \"personal_city\": \"New York\",
    \"personal_state\": \"NY\",
    \"personal_country\": \"US\",
    \"personal_postal_code\": \"10001\",
    \"citizenship\": 4
}"

The above command returns JSON structured like this:


{
    "data": {
        "id": "317fdf56-cc6d-4856-bde5-0bcb2e79b41e",
        "business": {
            "business_legal_name": "Example Company",
            "doing_business_as": "Sample",
            "has_website": null,
            "website_address": null,
            "is_ecommerce": null,
            "tax_exempt": null,
            "preferred_contact_method": null,
            "actual_monthly_revenue": null,
            "estimated_annual_revenue": null,
            "finished_type": null,
            "business_start_date": "2020-02-01",
            "sole_owner": true,
            "ownership_percentage": null,
            "industry_type_id": null,
            "number_of_employees_id": null,
            "business_entity_type_id": 1,
            "actual_credit_score": null,
            "credit_limit": null,
            "credit_utilization": null,
            "inquiries": null
        },
        "personal_information": {
            "id": 23,
            "first_name": "Test",
            "last_name": "Application",
            "telephone": "2035258209",
            "citizenship": null,
            "email_address": "example@email.com",
            "date_of_birth": "1958-03-03",
            "job_title": null,
            "signature_status": null,
            "ownership_percentage": "100.00"
        },
        "naics_code": null,
        "industry": null,
        "business_notes": null,
        "status": "Started"
    }
}

Received response:

Request failed with error:

URL Parameters

application string

Application uuid.

Body Parameters

is_home_business boolean

is_sole_owner boolean

job_title string optional

owner_percentage number

Must be at least 0.01. Must not be greater than 100.

business_start_date string

Must be a valid date in the format Y-m-d.

personal_address string

personal_address_2 string optional

personal_city string

Must not be greater than 50 characters.

personal_state string

personal_country string

personal_postal_code string

citizenship number optional

Must be one of 1, 2, 3, or 4.

Application Offers

Requires Authentication

A paginated list of offers for a single application. The example responses detail the set of attributes available for offers tied to each supported product type. The actual response can contain offers tied to a mix of product types (See 'Full example').

GET api/v2/applications/{application}/offers

Use the following command

curl --request GET \
    --get "https://api.lendflow.com/api/v2/applications/317fdf56-cc6d-4856-bde5-0bcb2e79b41e/offers" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

The above command returns JSON structured like this:


{
    "data": [
        {
            "id": "3ef9a4fe-283e-4b1e-901c-6f19d0c95bb6",
            "application_id": "3d0170c6-9ce3-46b0-8ece-06f00c7a56d1",
            "offer_amount": 50000,
            "payback_amount": 65000,
            "payment_amount": 1400,
            "number_of_payments": 24,
            "max_sell_interest_rate": 1.1,
            "min_buy_interest_rate": 1.5,
            "payment_frequency": 14,
            "term_length": 48,
            "product": "Term loan",
            "start_date": "2021-06-04",
            "end_date": "2021-06-11"
        }
    ]
}

The above command returns JSON structured like this:


{
    "data": [
        {
            "id": "5e1afe6e-1480-41dc-a51d-1bb145654f1d",
            "application_id": "e8c214b1-c1cf-49bc-90a0-9f38be2084bc",
            "max_facility_amount": 100000,
            "advance_rate": 75,
            "30_day_discount_rate": 0.25,
            "10_day_discount_rate_after_initial_30_days": 0.28,
            "expense_deposit": 2500,
            "origination_fee": 1500,
            "renewal": 425,
            "term": 48,
            "product": "ARLOC",
            "start_date": "2021-06-04",
            "end_date": "2021-06-11"
        }
    ]
}

The above command returns JSON structured like this:


{
    "data": [
        {
            "id": "9a8587c8-5e0d-4218-95ec-86b35aa44079",
            "application_id": "1095003b-837a-491e-a8ce-dababc799154",
            "offer_amount": 50000,
            "payback_amount": 65000,
            "payment_amount": 1400,
            "number_of_payments": 24,
            "max_sell_factor_rate": 1.1,
            "min_buy_factor_rate": 1.5,
            "payment_frequency": 14,
            "term_length": 48,
            "product": "Receivables Purchase",
            "start_date": "2021-06-04",
            "end_date": "2021-06-11"
        }
    ]
}

The above command returns JSON structured like this:


{
    "data": [
        {
            "id": "58776328-5d25-43e0-b4e7-91da4c05d1cd",
            "application_id": "5cdbd684-627e-43b2-a12e-a37840e59ca5",
            "max_line_of_credit": 250000,
            "max_term": 48,
            "payment_frequency": 14,
            "monthly_interest": 2.8,
            "first_draw_commission": 1.2,
            "subsequent_draw_commission": 1.1,
            "product": "Line of credit",
            "start_date": "2021-06-04",
            "end_date": "2021-06-11"
        }
    ]
}

The above command returns JSON structured like this:


{
    "data": [
        {
            "id": "65d79d9b-c614-46fd-884d-be9128d7c4d5",
            "application_id": "d9effe44-1bc0-4b97-9234-9d8a506e71a2",
            "max_facility_amount": 100000,
            "advance_rate": 75,
            "30_day_discount_rate": 0.25,
            "10_day_discount_rate_after_initial_30_days": 0.28,
            "expense_deposit": 2500,
            "origination_fee": 1500,
            "renewal": 425,
            "term": 48,
            "product": "ARLOC",
            "start_date": "2021-06-04",
            "end_date": "2021-06-11"
        },
        {
            "id": "9a8587c8-5e0d-4218-95ec-86b35aa44079",
            "application_id": "1095003b-837a-491e-a8ce-dababc799154",
            "offer_amount": 50000,
            "payback_amount": 65000,
            "payment_amount": 1400,
            "number_of_payments": 24,
            "max_sell_factor_rate": 1.1,
            "min_buy_factor_rate": 1.5,
            "payment_frequency": 14,
            "term_length": 48,
            "product": "Receivables Purchase",
            "start_date": "2021-06-04",
            "end_date": "2021-06-11"
        },
        {
            "id": "58776328-5d25-43e0-b4e7-91da4c05d1cd",
            "application_id": "5cdbd684-627e-43b2-a12e-a37840e59ca5",
            "max_line_of_credit": 250000,
            "max_term": 48,
            "payment_frequency": 14,
            "monthly_interest": 2.8,
            "first_draw_commission": 1.2,
            "subsequent_draw_commission": 1.1,
            "product": "Line of credit",
            "start_date": "2021-06-04",
            "end_date": "2021-06-11"
        }
    ]
}

Received response:

Request failed with error:

Upload Application Files

Requires Authentication

POST api/v2/applications/{application}/files

Use the following command

curl --request POST \
    "https://api.lendflow.com/api/v2/applications/317fdf56-cc6d-4856-bde5-0bcb2e79b41e/files" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "file_type=signed_application_doc" \
    --form "offer_stip_id=17" \
    --form "application_stip_id=17" \
    --form "owner_id=17" \
    --form "product_id=4" \
    --form "file=@/tmp/phpY7Llaq"

The above command returns JSON structured like this:


{
    "data": {
        "id": 2,
        "mime_type": "application/pdf",
        "original_name": "form_w9.pdf",
        "file_url": "",
        "file_type": "w9",
        "file_size": 529590,
        "created_at": "2021-04-29T14:07:30.000000Z",
        "updated_at": "2021-04-29T14:07:30.000000Z",
        "product_id": null
    }
}

Received response:

Request failed with error:

URL Parameters

application string

Application uuid.

Body Parameters

file_type string

Must be one of tax_return_1, tax_return_2, tax_return_3, ap_document_1, ap_document_2, financial_document_1, financial_document_2, financial_document_3, financial_document_4, bank_statements_1, bank_statements_2, bank_statements_3, bank_statements_4, bank_statements_5, bank_statements_6, bank_statements_7, bank_statements_8, bank_statements_9, bank_statements_10, bank_statements_11, bank_statements_12, offer_stip, application_stip, contract, inquiries, tax_exemption, insurance_certificate, plaid_statement, signed_application_doc, verification_doc, raw_cfa_data, or xlsx_cfa_data.

file file

The allowed extension for files are: pdf,gif,jpeg,png,xls,xlst,doc,docx. Must be a file. Must not be greater than 51200 kilobytes.

offer_stip_id integer optional

application_stip_id integer optional

owner_id integer optional

product_id integer optional

Must be one of 1, 2, 3, 4, 5, or 6.

Decline Current Offers

Requires Authentication

An applicant can decline all current offers for the application. This will send an email including the provided feedback to the application's funding advisor and underwriter so applicant can get help finding the right lending solution.

POST api/v2/applications/{application}/decline-offers

Use the following command

curl --request POST \
    "https://api.lendflow.com/api/v2/applications/317fdf56-cc6d-4856-bde5-0bcb2e79b41e/decline-offers" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"feedback\": \"Here is some example feedback.\"
}"

The above command returns JSON structured like this:

[Empty response]

The above command returns JSON structured like this:


{
    "message": "The application has no offers"
}

Received response:

Request failed with error:

Save Business Address

Requires Authentication

PUT api/v2/applications/{application}/business_address

Use the following command

curl --request PUT \
    "https://api.lendflow.com/api/v2/applications/317fdf56-cc6d-4856-bde5-0bcb2e79b41e/business_address" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"business_address\": \"24th Street\",
    \"business_address_2\": \"123\",
    \"business_city\": \"vmqeopfuudtdsufvyvddqamniihfqcoynlazghdtq\",
    \"business_state\": \"NY\",
    \"business_country\": \"US\",
    \"business_postal_code\": \"10001\",
    \"business_entity\": \"business_entity_type_1\"
}"

The above command returns JSON structured like this:


{
    "data": {
        "id": "317fdf56-cc6d-4856-bde5-0bcb2e79b41e",
        "business": {
            "business_legal_name": "Example Company",
            "doing_business_as": "Sample",
            "has_website": null,
            "website_address": null,
            "is_ecommerce": null,
            "tax_exempt": null,
            "preferred_contact_method": null,
            "actual_monthly_revenue": null,
            "estimated_annual_revenue": null,
            "finished_type": null,
            "business_start_date": "2020-02-01",
            "sole_owner": true,
            "ownership_percentage": null,
            "industry_type_id": null,
            "number_of_employees_id": null,
            "business_entity_type_id": 1,
            "actual_credit_score": null,
            "credit_limit": null,
            "credit_utilization": null,
            "inquiries": null
        },
        "personal_information": {
            "id": 23,
            "first_name": "Test",
            "last_name": "Application",
            "telephone": "2035258209",
            "citizenship": null,
            "email_address": "example@email.com",
            "date_of_birth": "1958-03-03",
            "job_title": null,
            "signature_status": null,
            "ownership_percentage": "100.00"
        },
        "naics_code": null,
        "industry": null,
        "business_notes": null,
        "status": "Started"
    }
}

Received response:

Request failed with error:

URL Parameters

application string

Application uuid.

Body Parameters

business_address string

business_address_2 string optional

business_city string

Must not be greater than 50 characters.

business_state string

Two-letter state code.

business_country string

business_postal_code string

business_entity string

business_entity_type_1, business_entity_type_2, business_entity_type_3, business_entity_type_4, business_entity_type_5, business_entity_type_6, business_entity_type_7, business_entity_type_41.

Save PIIs

Requires Authentication

PUT api/v2/applications/{application}/piis

Use the following command

curl --request PUT \
    "https://api.lendflow.com/api/v2/applications/317fdf56-cc6d-4856-bde5-0bcb2e79b41e/piis" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"date_of_birth\": \"2021-12-3\",
    \"tax_exempt\": false
}"

The above command returns JSON structured like this:


{
    "data": {
        "id": "317fdf56-cc6d-4856-bde5-0bcb2e79b41e",
        "business": {
            "business_legal_name": "Example Company",
            "doing_business_as": "Sample",
            "has_website": null,
            "website_address": null,
            "is_ecommerce": null,
            "tax_exempt": null,
            "preferred_contact_method": null,
            "actual_monthly_revenue": null,
            "estimated_annual_revenue": null,
            "finished_type": null,
            "business_start_date": "2020-02-01",
            "sole_owner": true,
            "ownership_percentage": null,
            "industry_type_id": null,
            "number_of_employees_id": null,
            "business_entity_type_id": 1,
            "actual_credit_score": null,
            "credit_limit": null,
            "credit_utilization": null,
            "inquiries": null
        },
        "personal_information": {
            "id": 23,
            "first_name": "Test",
            "last_name": "Application",
            "telephone": "2035258209",
            "citizenship": null,
            "email_address": "example@email.com",
            "date_of_birth": "1958-03-03",
            "job_title": null,
            "signature_status": null,
            "ownership_percentage": "100.00"
        },
        "naics_code": null,
        "industry": null,
        "business_notes": null,
        "status": "Started"
    }
}

Received response:

Request failed with error:

URL Parameters

application string

Application uuid.

Body Parameters

date_of_birth string optional

Must be a valid date in the format Y-n-j.

social_security_number string optional

employee_identification_number string optional

business_number string optional

social_insurance_number string optional

individual_taxpayer_identification_number string optional

tax_exempt boolean optional

Save Application Funds

Requires Authentication

PUT api/v2/applications/{application}/fund

Use the following command

curl --request PUT \
    "https://api.lendflow.com/api/v2/applications/317fdf56-cc6d-4856-bde5-0bcb2e79b41e/fund" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"use_of_fund\": \"use_of_funds_1\",
    \"funds_needed_time\": \"funds_needed_time_1\"
}"

The above command returns JSON structured like this:


{
    "docusign_link": "http://example/link",
    "plaid_link_token": "token"
}

Received response:

Request failed with error:

URL Parameters

application string

Application uuid.

Body Parameters

use_of_fund string

use_of_funds_1, use_of_funds_2, use_of_funds_3, use_of_funds_4, use_of_funds_5, use_of_funds_6, use_of_funds_7, use_of_funds_8, use_of_funds_9, use_of_funds_10, use_of_funds_11, use_of_funds_12.

funds_needed_time string

funds_needed_time_1, funds_needed_time_2, funds_needed_time_3, funds_needed_time_4, funds_needed_time_5.

Get required stips for single offer

Requires Authentication

GET api/v2/offers/{offer}/required-stips

Use the following command

curl --request GET \
    --get "https://api.lendflow.com/api/v2/offers/317fdf56-cc6d-4856-bde5-0bcb2e79b41e/required-stips" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

The above command returns JSON structured like this:


{
    "data": [
        {
            "id": 1,
            "stip_id": 1,
            "name": "UCCS docs",
            "description": "",
            "files": [],
            "is_finished": false
        },
        {
            "id": 1,
            "stip_id": 1,
            "name": "UCCS docs",
            "description": "",
            "files": [],
            "is_finished": false
        }
    ]
}

Received response:

Request failed with error:

Get all Offers

Requires Authentication

GET api/v2/offers

Use the following command

curl --request GET \
    --get "https://api.lendflow.com/api/v2/offers?complete=" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

The above command returns JSON structured like this:


{
    "data": [
        {
            "id": "0028983d-d056-4598-8543-db6f76eb72cb",
            "application_id": "c122ad47-8af9-4604-8924-f9fa55a3590a",
            "start_date": null,
            "end_date": null,
            "product": "Receivables Purchase",
            "offer_amount": 65000,
            "payback_amount": 90350,
            "payment_amount": 1882.29,
            "number_of_payments": 48,
            "max_sell_factor_rate": 1.39,
            "min_buy_factor_rate": 1.29,
            "payment_frequency": 2,
            "term_length": 11.54,
            "offer_generated_date": "2021-10-14T12:43:54.000000Z",
            "offer_expiration_date": null,
            "max_commission_rate": null
        },
        {
            "id": "0028983d-d056-4598-8543-db6f76eb72cb",
            "application_id": "c122ad47-8af9-4604-8924-f9fa55a3590a",
            "start_date": null,
            "end_date": null,
            "product": "Receivables Purchase",
            "offer_amount": 65000,
            "payback_amount": 90350,
            "payment_amount": 1882.29,
            "number_of_payments": 48,
            "max_sell_factor_rate": 1.39,
            "min_buy_factor_rate": 1.29,
            "payment_frequency": 2,
            "term_length": 11.54,
            "offer_generated_date": "2021-10-14T12:43:54.000000Z",
            "offer_expiration_date": null,
            "max_commission_rate": null
        }
    ]
}

Received response:

Request failed with error:

Monthly Revenues

Requires Authentication

This endpoint, shows the users all the available monthly revenue options/category from Lendflow system

GET api/v2/monthly_revenues

Use the following command

curl --request GET \
    --get "https://api.lendflow.com/api/v2/monthly_revenues" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

The above command returns JSON structured like this:


{
    "data": [
        {
            "key": "monthly_avg_revenue_1",
            "range": "0 - 4000"
        },
        {
            "key": "monthly_avg_revenue_1",
            "range": "0 - 4000"
        }
    ]
}

Received response:

Request failed with error:

Introduction

1. Authentication

Get Bearer token

Try it out Cancel Send Request 💥

Get User Details

Try it out Cancel Send Request 💥

Refresh access token

Try it out Cancel Send Request 💥

2. Capital Qualification

Pre-Qualification

Try it out Cancel Send Request 💥

3. Capital Application

Apply for Capital

Try it out Cancel Send Request 💥

Retrieve Applications

Try it out Cancel Send Request 💥

Retrieve Single Application

Try it out Cancel Send Request 💥

4. Application Offers

Get all Offers

Try it out Cancel Send Request 💥

5. Business Credit Application

Apply for Business Credit

Try it out Cancel Send Request 💥

Enrich Business Credit Application

Try it out Cancel Send Request 💥

Create Document Verification

Try it out Cancel Send Request 💥

Pull Application Commercial Data

Try it out Cancel Send Request 💥

6. Advanced Integrations

Generate Plaid and Docusign links

Try it out Cancel Send Request 💥

Update Lendflow Plaid records

Try it out Cancel Send Request 💥

Finish application processing

Try it out Cancel Send Request 💥

7. NextGen

Save prequalification record

Try it out Cancel Send Request 💥

Create Application From Pre-Qualification

Try it out Cancel Send Request 💥

Create Application With Plaid

Try it out Cancel Send Request 💥

Retrieve single Application details

Try it out Cancel Send Request 💥

Retrieve Applications

Try it out Cancel Send Request 💥

Add Application Metadata

Try it out Cancel Send Request 💥

Save Personal Address

Try it out Cancel Send Request 💥

Application Offers

Try it out Cancel Send Request 💥

Upload Application Files

Try it out Cancel Send Request 💥

Decline Current Offers

Try it out Cancel Send Request 💥

Save Business Address

Try it out Cancel Send Request 💥

Save PIIs

Try it out Cancel Send Request 💥

Save Application Funds

Try it out Cancel Send Request 💥

Get required stips for single offer

Try it out Cancel Send Request 💥

Get all Offers

Try it out Cancel Send Request 💥

Monthly Revenues

Try it out Cancel Send Request 💥