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.
Get Bearer token
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": 7200
}
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": null,
"first_name": "Ivah",
"last_name": "Ankunding",
"email": "98325be827a60-115b-338f-ab56-09ca3a917246@example.com",
"pending_email": null,
"roles": [],
"widget_token": null,
"created_at": null,
"phone": null,
"client_id": null
}
}
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": 7200
}
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\": \"2022-12-01T20:29:37\",
\"statement_amount\": 11613.31890586
},
{
\"statement_date\": \"2022-12-01T20:29:37\",
\"statement_amount\": 11613.31890586
},
{
\"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:
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\": \"vmqeopfuudtdsufvyvddqamniihfqcoynlazghdtqtqxbajwbpilpmufinllwloauydlsmsjuryvojcybzvrbyickznkygloigmkwxphlvazjrcnfbaqywuxhgjjmzuxjubqouzswiwxtrkimfcatbxspzmrazsroyjpxmqesedyghenqcopwvownkbamlnfngefbei\",
\"use_of_funds\": \"Expand business\",
\"amount_needed\": 300000,
\"country\": \"US\",
\"business_entity_type\": \"LLC\",
\"business_start_date\": \"2017-03-29\",
\"business_address\": \"25th Street 120\",
\"business_city\": \"New York\",
\"business_state\": \"NY\",
\"business_zip\": \"10001\",
\"owner_date_of_birth\": \"2002-08-25\",
\"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\": 1,
\"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\": \"2002-08-25\",
\"ownership\": 50
}
]
}"
The above command returns JSON structured like this:
{
"code": 201,
"data": {
"application_identifier": "XXXX"
}
}
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/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": "5b4a7b5a-77bd-41e2-b6d8-0e37bee1410a",
"token": null,
"business_name": "Boyle-Macejkovic",
"first_name": "Santiago",
"last_name": "Kemmer",
"telephone": "2125555555",
"state": "CA",
"email": "cb34197f-9108-3948-aa73-88d0c8e993ed@example.com",
"status": "Started",
"tracking_tokens": [
"Qd8sH0rPJhF6JX3F",
"qYU88mrXGPYroN9m",
"Sr9t9aI7UIRb8y9e"
]
},
{
"uuid": "98bf99ef-c1da-441d-9229-8f7fba6fc5e0",
"token": null,
"business_name": "Durgan-Cole",
"first_name": "Emmie",
"last_name": "Bechtelar",
"telephone": "2125555555",
"state": "CA",
"email": "93402d5c-804b-3939-a13b-acb4074d3a73@example.com",
"status": "Started",
"tracking_tokens": [
"kEWJpwJHdpOMbK5O",
"kU1sHwljd2VYeyZ2",
"2luIESUIeGanyn0Y"
]
}
],
"links": {
"first": "/?page=1",
"last": "/?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "/?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"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": "000014ac-e23c-491b-8605-5111d2e1372c",
"token": null,
"business_name": "Today I K transport inc",
"first_name": "Vikramjeet",
"last_name": "Singh",
"telephone": "5103076547",
"state": "CA",
"email": "todayiktransportinc@gmail.com",
"status": "Underwriting",
"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": "ALP Operations LLC",
"deal": "1548d11a-9c4e-4e78-a14e-5243a7c40b74",
"date_offer": "2022-06-14T20:17:08.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": "ALP Operations LLC",
"deal": "1548d11a-9c4e-4e78-a14e-5243a7c40b74",
"date_offer": "2022-06-14T20:17:08.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[]=plaid_asset_report" \
--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]=Suite 500" \
--form "personal_address[city]=New York" \
--form "personal_address[state]=NY" \
--form "personal_address[country]=US" \
--form "personal_address[zip]=10001" \
--form "document_verifications[][service]=persona" \
--form "other_owners[][first_name]=John" \
--form "other_owners[][last_name]=Doe" \
--form "other_owners[][email_address]=qkunze@example.com" \
--form "other_owners[][address]=25th Street 121" \
--form "other_owners[][country]=US" \
--form "other_owners[][city]=New York" \
--form "other_owners[][state]=NY" \
--form "other_owners[][zip]=10001" \
--form "other_owners[][ssn]=123456789" \
--form "other_owners[][dob]=2002-08-25" \
--form "other_owners[][ownership]=50" \
--form "widget_type=17" \
--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 "plaid[transactions][]=consequatur" \
--form "plaid[asset_report][]=consequatur" \
--form "bank_statements[][file]=@/tmp/php6YbFPJ" The above command returns JSON structured like this:
{
"application_id": "XXXX"
}
Received response:
Request failed with error:
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[]=plaid_asset_report" \
--form "bank_statements[][type]=bank_statements_4" \
--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 "plaid[transactions][]=consequatur" \
--form "plaid[asset_report][]=consequatur" \
--form "bank_statements[][file]=@/tmp/phpHSfJGH" The above command returns JSON structured like this:
{
"enrichment_started": true
}
Received response:
Request failed with error:
Create Document Verification
Requires Authentication
Verify a document against a 3rd party service. Currently supports Persona's government ID verification, Inscribe document verification and Socure'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:
verification=government-idtype(state_id/passport/drivers_license)front_photoback_photo(this is optional, but helps with verification)
For Inscribe document verification the following additional request parameters are required:
verification=documentdocumenttype(drivers_license/social_security_card/bank_statement/payslip/tax_form/invoice/utility_bill/check/business_filing/financial_statement/unknown)
For Socure's Government ID verification the following additional request parameters are required:
verification=government-idtype(state_id/passport/drivers_license)front_photoback_photo(this is optional, but helps with verification)self_portrait(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=passport" \
--form "front_photo=@/tmp/phptXNVbL" \
--form "back_photo=@/tmp/phpxftVFH" \
--form "self_portrait=@/tmp/phpu56BSK" \
--form "document=@/tmp/phpq3O4tL" 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": "2022-04-21T16:46:49.000000Z",
"submitted_at": "2021-07-05T07:51:10.000000Z",
"received_at": "2021-07-05T07:51:10.000000Z",
"passed_at": null,
"failed_at": "2021-07-05T07:51:21.000000Z",
"has_passed": false,
"has_failed": true,
"document_type": null
}
}
Received response:
Request failed with error:
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": null,
"business_legal_name": "Hermiston-Hamill",
"dates": [],
"statuses": {
"middesk": "Not yet started",
"sentilink": "Not yet started",
"sentilink_ssn_completion": "Not yet started",
"sentilink_dob_completion": "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",
"bm_l1": "Not yet started"
},
"experian": {
"intelliscore": "Not yet started",
"intelliscore_v3": "Not yet started",
"uccs": "Not yet started",
"bankruptcies": "Not yet started",
"judgments": "Not yet started",
"liens": "Not yet started",
"fsr": "Not yet started",
"fsr_v2": "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",
"gdn": {
"company_profile": "Not yet started",
"risk_check": "Not yet started",
"small_report": "Not yet started",
"extended_report": "Not yet started",
"canadian_profile_report": "Not yet started"
},
"business_match": "Not yet started",
"bop": {
"blended_prequalification": {
"vantage4": "Not yet started",
"fico8": "Not yet started",
"fico9": "Not yet started",
"fico_v2": "Not yet started",
"fico_advanced2": "Not yet started"
},
"commercial_lending_to_a_sole_prop": {
"vantage4": "Not yet started",
"fico8": "Not yet started",
"fico9": "Not yet started",
"fico_v2": "Not yet started",
"fico_advanced2": "Not yet started"
},
"commercial_lending_with_a_pg": {
"vantage4": "Not yet started",
"fico8": "Not yet started",
"fico9": "Not yet started",
"fico_v2": "Not yet started",
"fico_advanced2": "Not yet started"
},
"commercial_insurance": {
"vantage4": "Not yet started",
"fico8": "Not yet started",
"fico9": "Not yet started",
"fico_v2": "Not yet started",
"fico_advanced2": "Not yet started"
},
"merchant_cash_advance": {
"vantage4": "Not yet started",
"fico8": "Not yet started",
"fico9": "Not yet started",
"fico_v2": "Not yet started",
"fico_advanced2": "Not yet started"
},
"merchant_acquisition": {
"vantage4": "Not yet started",
"fico8": "Not yet started",
"fico9": "Not yet started",
"fico_v2": "Not yet started",
"fico_advanced2": "Not yet started"
},
"commercial_factoring": {
"vantage4": "Not yet started",
"fico8": "Not yet started",
"fico9": "Not yet started",
"fico_v2": "Not yet started",
"fico_advanced2": "Not yet started"
},
"blended_account_review": {
"vantage4": "Not yet started",
"fico8": "Not yet started",
"fico9": "Not yet started",
"fico_v2": "Not yet started",
"fico_advanced2": "Not yet started"
},
"commercial_collections": {
"vantage4": "Not yet started",
"fico8": "Not yet started",
"fico9": "Not yet started",
"fico_v2": "Not yet started",
"fico_advanced2": "Not yet started"
}
}
},
"ocrolus_cfa": "Not yet started",
"plaid": "Not yet started",
"ekata": "Not yet started",
"heron": "Not yet started",
"equifax": {
"bpr": "Not yet started"
},
"scorely": "Not yet started",
"clear": {
"person_search": "Not yet started",
"clear_id_confirm_person": "Not yet started",
"clear_risk_inform_person_search": "Not yet started",
"clear_risk_inform_person_report": "Not yet started",
"clear_id_confirm_business": "Not yet started",
"clear_risk_inform_business_search": "Not yet started",
"clear_risk_inform_business_report": "Not yet started",
"clear_court_search": "Not yet started",
"clear_adverse_media_search": "Not yet started",
"clear_adverse_media_report": "Not yet started"
},
"socure": {
"kyc": "Not yet started",
"fraud": "Not yet started"
},
"enigma": {
"business_match": "Not yet started",
"business_lookup": "Not yet started"
},
"lexis_nexis": {
"kyc": "Not yet started",
"kyc_report": "Not yet started",
"kyb_search": "Not yet started",
"kyb_report": "Not yet started",
"corporate_filing_search": "Not yet started",
"corporate_filing_report": "Not yet started",
"ucc_filing_search": "Not yet started",
"ucc_filing_report": "Not yet started",
"bankruptcy_search": "Not yet started",
"bankruptcy_report": "Not yet started",
"liens_search": "Not yet started",
"liens_report": "Not yet started",
"judgments_search": "Not yet started",
"judgments_report": "Not yet started"
},
"codat": "Not yet started",
"railz": "Not yet started",
"rutter": "Not yet started",
"mx": "Not yet started"
},
"commercial_data": {
"middesk": null,
"sentilink": null,
"sentilink_ssn_completion": null,
"sentilink_dob_completion": null,
"experian": {
"intelliscore": null,
"intelliscore_v3": null,
"uccs": null,
"bankruptcies": null,
"judgments": null,
"liens": null,
"fsr": null,
"fsr_v2": null,
"commercial_collections": null,
"credit_statuses": null,
"legal_collections": null,
"trades": null,
"corporate_registrations": null,
"contacts": null,
"facts": null,
"fraud_shields": null,
"gdn": {
"company_profile": null,
"risk_check": null,
"small_report": null,
"extended_report": null,
"canadian_profile_report": null
},
"bop": {
"blended_prequalification": null,
"commercial_lending_to_a_sole_prop": null,
"commercial_lending_with_a_pg": null,
"commercial_insurance": null,
"merchant_cash_advance": null,
"merchant_acquisition": null,
"commercial_factoring": null,
"blended_account_review": null,
"commercial_collections": null
},
"business_match": null
},
"dnb": {
"cer_l1": null,
"fi_l2": null,
"fi_l3": null,
"dti_l1": null,
"assessment": null,
"duns": null,
"primary_name": null,
"number_of_employees": null,
"business_trading": null,
"bm_l1": null
},
"equifax": {
"bpr": null
},
"scorely": null,
"ekata": null,
"clear": {
"person_search": null,
"clear_id_confirm_person": null,
"clear_risk_inform_person_search": null,
"clear_risk_inform_person_report": null,
"clear_id_confirm_business": null,
"clear_risk_inform_business_search": null,
"clear_risk_inform_business_report": null,
"clear_court_search": null,
"clear_adverse_media_search": null,
"clear_adverse_media_report": null
},
"socure": {
"kyc": null,
"fraud": null
},
"enigma": {
"business_match": null,
"business_lookup": null
},
"lexis_nexis": {
"kyc": null,
"kyc_report": null,
"kyb_search": null,
"kyb_report": null,
"corporate_filing_search": null,
"corporate_filing_report": null,
"ucc_filing_search": null,
"ucc_filing_report": null,
"bankruptcy_search": null,
"bankruptcy_report": null,
"liens_search": null,
"liens_report": null,
"judgments_search": null,
"judgments_report": null
},
"codat": [],
"railz": [],
"rutter": [],
"heron": {
"pnl": null,
"pnl_transactions": null
}
},
"request_data": {
"middesk": null,
"sentilink": null,
"sentilink_ssn_completion": null,
"sentilink_dob_completion": null,
"experian": {
"intelliscore": null,
"intelliscore_v3": null,
"uccs": null,
"bankruptcies": null,
"judgments": null,
"liens": null,
"fsr": null,
"fsr_v2": null,
"commercial_collections": null,
"credit_statuses": null,
"legal_collections": null,
"trades": null,
"corporate_registrations": null,
"contacts": null,
"facts": null,
"fraud_shields": null,
"gdn": {
"company_profile": null,
"risk_check": null,
"small_report": null,
"extended_report": null,
"canadian_profile_report": null
},
"bop": {
"blended_prequalification": null,
"commercial_lending_to_a_sole_prop": null,
"commercial_lending_with_a_pg": null,
"commercial_insurance": null,
"merchant_cash_advance": null,
"merchant_acquisition": null,
"commercial_factoring": null,
"blended_account_review": null,
"commercial_collections": null
}
},
"dnb": {
"cer_l1": null,
"fi_l2": null,
"fi_l3": null,
"dti_l1": null
},
"equifax": {
"bpr": null
},
"scorely": null,
"ekata": null,
"clear": {
"person_search": null,
"clear_id_confirm_person": null,
"clear_risk_inform_person_search": null,
"clear_risk_inform_person_report": null,
"clear_id_confirm_business": null,
"clear_risk_inform_business_search": null,
"clear_risk_inform_business_report": null,
"clear_court_search": null,
"clear_adverse_media_search": null,
"clear_adverse_media_report": null
},
"socure": {
"kyc": null,
"fraud": null
},
"enigma": {
"business_match": null,
"business_lookup": null
},
"lexis_nexis": {
"kyc": null,
"kyc_report": null,
"kyb_search": null,
"kyb_report": null,
"corporate_filing_search": null,
"corporate_filing_report": null,
"ucc_filing_search": null,
"ucc_filing_report": null,
"bankruptcy_search": null,
"bankruptcy_report": null,
"liens_search": null,
"liens_report": null,
"judgments_search": null,
"judgments_report": null
}
}
}
}
Received response:
Request failed with error:
6. Advanced Integrations
Generate Plaid, Docusign and Codat links
Requires Authentication
This endpoint generates the Docusign link, the Plaid link_code and the Codat link.
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",
"codat_link": "https://link.codat.io/company/396952ad-99cb-49ea-a867-b76561984bdf",
"rutter" : [
"shopify_link": "https://link.rutterapi.com/connection/connectionId?platform=SHOPIFY",
"amazon_link": "https://link.rutterapi.com/connection/connectionId?platform=AMAZON",
"woo_commerce_link": "https://link.rutterapi.com/connection/connectionId?platform=WOO_COMMERCE",
"prestashop_link": "https://link.rutterapi.com/connection/connectionId?platform=PRESTASHOP",
"magento_link": "https://link.rutterapi.com/connection/connectionId?platform=MAGENTO",
]
}
}
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\": \"6\",
\"requested_products\": [
\"plaid_asset_report\",
\"lexis_nexis_kyc_report\"
],
\"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:
7. NextGen
NextGen API endpoints
Experian Service Availability
Requires Authentication
Is Lendflow's Experian service integration available?
GET
api/v2/service_availability/experian
Use the following command
curl --request GET \
--get "https://api.lendflow.com/api/v2/service_availability/experian" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"The above command returns JSON structured like this:
[Empty response]
The above command returns JSON structured like this:
{'Experian is currently unavailable.'}
Received response:
Request failed with error:
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": 10000,
"prequalification_amount_max": 25000,
"prequalification_id": "238406d1-1a8c-4626-ba77-8646b1ef2fc4",
"time_in_business": "time_in_business_2",
"monthly_avg_revenue": "monthly_avg_revenue_5",
"credit_score": "credit_score_2",
"requested_amount": 2179864.41,
"currency": "USD"
}
}
Received response:
Request failed with error:
Apply for Capital
Requires Authentication
Create application with or without prequalification
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": "000014ac-e23c-491b-8605-5111d2e1372c",
"business": {
"id": 101660,
"business_legal_name": "Today I K transport inc",
"doing_business_as": null,
"has_website": null,
"website_address": null,
"is_ecommerce": null,
"tax_exempt": null,
"preferred_contact_method": null,
"actual_monthly_revenue": null,
"estimated_annual_revenue": null,
"experian_bin": "513030667",
"duns_number": "031687357",
"finished_type": null,
"business_start_date": "2000-01-01",
"formation_state": null,
"fiscal_year_end": null,
"business_management_software": null,
"naics_code": null,
"sic_code": null,
"sole_owner": null,
"is_home_base": null,
"ownership_percentage": null,
"industry_type_id": null,
"sub_industry_type_id": null,
"industry_other": null,
"number_of_employees_id": null,
"business_entity_type_id": 4,
"is_codat_linked": 0,
"is_railz_linked": 0
},
"personal_information": {
"id": 101632,
"first_name": "Vikramjeet",
"last_name": "Singh",
"telephone": "5103076547",
"is_primary": true,
"citizenship": null,
"country_of_citizenship": null,
"email_address": "todayiktransportinc@gmail.com",
"date_of_birth": null,
"job_title": null,
"primary_language_spoken": 3,
"ownership_percentage": "100.00",
"has_credit_permission": null,
"driving_license_number": null,
"driving_license_state_id": null,
"total_debt": null,
"personal_income": null,
"actual_credit_score": null,
"credit_limit": null,
"credit_utilization": null,
"inquiries": null,
"additional_telephones": null,
"additional_emails": null
},
"naics_code": null,
"sic_code": null,
"status": "Underwriting"
}
}
Received response:
Request failed with error:
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": "000014ac-e23c-491b-8605-5111d2e1372c",
"business": {
"id": 101660,
"business_legal_name": "Today I K transport inc",
"doing_business_as": null,
"has_website": null,
"website_address": null,
"is_ecommerce": null,
"tax_exempt": null,
"preferred_contact_method": null,
"actual_monthly_revenue": null,
"estimated_annual_revenue": null,
"experian_bin": "513030667",
"duns_number": "031687357",
"finished_type": null,
"business_start_date": "2000-01-01",
"formation_state": null,
"fiscal_year_end": null,
"business_management_software": null,
"naics_code": null,
"sic_code": null,
"sole_owner": null,
"is_home_base": null,
"ownership_percentage": null,
"industry_type_id": null,
"sub_industry_type_id": null,
"industry_other": null,
"number_of_employees_id": null,
"business_entity_type_id": 4,
"is_codat_linked": 0,
"is_railz_linked": 0
},
"personal_information": {
"id": 101632,
"first_name": "Vikramjeet",
"last_name": "Singh",
"telephone": "5103076547",
"is_primary": true,
"citizenship": null,
"country_of_citizenship": null,
"email_address": "todayiktransportinc@gmail.com",
"date_of_birth": null,
"job_title": null,
"primary_language_spoken": 3,
"ownership_percentage": "100.00",
"has_credit_permission": null,
"driving_license_number": null,
"driving_license_state_id": null,
"total_debt": null,
"personal_income": null,
"actual_credit_score": null,
"credit_limit": null,
"credit_utilization": null,
"inquiries": null,
"additional_telephones": null,
"additional_emails": null
},
"naics_code": null,
"sic_code": null,
"status": "Underwriting"
}
}
Received response:
Request failed with error:
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": "000014ac-e23c-491b-8605-5111d2e1372c",
"client_tracking_token": null,
"business": {
"id": 101660,
"business_legal_name": "Today I K transport inc",
"doing_business_as": null,
"has_website": null,
"website_address": null,
"is_ecommerce": null,
"tax_exempt": null,
"preferred_contact_method": null,
"actual_monthly_revenue": null,
"estimated_annual_revenue": null,
"experian_bin": "513030667",
"duns_number": "031687357",
"finished_type": null,
"business_start_date": "2000-01-01",
"formation_state": null,
"fiscal_year_end": null,
"business_management_software": null,
"address": {
"id": 194655,
"address_line": "440 e. 3rd st",
"address_line2": null,
"country": "US",
"state": "CA",
"city": "tracy",
"zip": "95376",
"is_primary": true
},
"naics_code": null,
"sic_code": null,
"sole_owner": null,
"is_home_base": null,
"ownership_percentage": null,
"industry_type_id": null,
"sub_industry_type_id": null,
"industry_other": null,
"number_of_employees_id": null,
"business_entity_type_id": 4,
"is_codat_linked": 0,
"is_railz_linked": 0
},
"status": 1,
"closing_status_id": null,
"progress": 55,
"use_of_fund_id": null,
"is_business_credit": true,
"is_equipment_rental": false,
"is_data_capture": false,
"is_discovery_complete": false,
"finished_type": 6,
"finished_at": "2022-04-07T15:40:30.000000Z",
"amount_needed": null,
"referrer_url": null,
"source": 1,
"stips": [],
"underwriter_review_needed": false,
"naics_code": null,
"sic_code": null,
"created_at": "2022-04-07T15:40:29.000000Z",
"offers_declined_feedback": null,
"offers_declined_at": null,
"has_bank_data": false,
"stage": null,
"is_client_funded": false,
"funded_amount": null,
"stated_monthly_revenue": null,
"score_card_id": null,
"score_card_group_id": null,
"has_insurance": null,
"deal_mode": 1,
"workflow": 2,
"debts": [],
"debtors": [],
"company_officers": [],
"status_description": "Application Complete",
"salesforce": {
"link": "https://lendflow2021.lightning.force.com/lightning/r/Opportunity/0065e00000IPRXNAA5/view",
"id": "0065e00000IPRXNAA5"
},
"tracking_tokens": [],
"workflow_snapshot": {
"id": 7618,
"name": "Global Business Credit Workflow",
"type": "linear",
"widget": [
"4",
"8"
],
"status": 2,
"created_at": "2022-10-27T15:43:55.000000Z",
"updated_at": "2022-10-27T15:43:55.000000Z",
"stage_id": "ff27b57f-acd7-48d3-bcea-70395b0f0d02",
"flow_id": "ff27b57f-acd7-48d3-bcea-70395b0f0d02",
"stage_category": "Collect Data",
"stage_name": "Application"
},
"stage_id": "ff27b57f-acd7-48d3-bcea-70395b0f0d02",
"stage_category": "Collect Data",
"stage_name": "Application",
"workflow_name": "Global Business Credit Workflow",
"workflow_category": 2,
"workflow_template_id": "dc096eb5-5085-4eec-9675-314a75c89591"
}
}
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": "000014ac-e23c-491b-8605-5111d2e1372c",
"client_tracking_token": null,
"business": {
"id": 101660,
"business_legal_name": "Today I K transport inc",
"doing_business_as": null,
"has_website": null,
"website_address": null,
"is_ecommerce": null,
"tax_exempt": null,
"preferred_contact_method": null,
"actual_monthly_revenue": null,
"estimated_annual_revenue": null,
"experian_bin": "513030667",
"duns_number": "031687357",
"finished_type": null,
"business_start_date": "2000-01-01",
"formation_state": null,
"fiscal_year_end": null,
"business_management_software": null,
"address": {
"id": 194655,
"address_line": "440 e. 3rd st",
"address_line2": null,
"country": "US",
"state": "CA",
"city": "tracy",
"zip": "95376",
"is_primary": true
},
"naics_code": null,
"sic_code": null,
"sole_owner": null,
"is_home_base": null,
"ownership_percentage": null,
"industry_type_id": null,
"sub_industry_type_id": null,
"industry_other": null,
"number_of_employees_id": null,
"business_entity_type_id": 4,
"is_codat_linked": 0,
"is_railz_linked": 0
},
"status": 1,
"closing_status_id": null,
"progress": 55,
"use_of_fund_id": null,
"is_business_credit": true,
"is_equipment_rental": false,
"is_data_capture": false,
"is_discovery_complete": false,
"finished_type": 6,
"finished_at": "2022-04-07T15:40:30.000000Z",
"amount_needed": null,
"referrer_url": null,
"source": 1,
"stips": [],
"underwriter_review_needed": false,
"naics_code": null,
"sic_code": null,
"created_at": "2022-04-07T15:40:29.000000Z",
"offers_declined_feedback": null,
"offers_declined_at": null,
"has_bank_data": false,
"stage": null,
"is_client_funded": false,
"funded_amount": null,
"stated_monthly_revenue": null,
"score_card_id": null,
"score_card_group_id": null,
"has_insurance": null,
"deal_mode": 1,
"workflow": 2,
"debts": [],
"debtors": [],
"company_officers": [],
"status_description": "Application Complete",
"salesforce": {
"link": "https://lendflow2021.lightning.force.com/lightning/r/Opportunity/0065e00000IPRXNAA5/view",
"id": "0065e00000IPRXNAA5"
},
"tracking_tokens": [],
"workflow_snapshot": {
"id": 7618,
"name": "Global Business Credit Workflow",
"type": "linear",
"widget": [
"4",
"8"
],
"status": 2,
"created_at": "2022-10-27T15:43:55.000000Z",
"updated_at": "2022-10-27T15:43:55.000000Z",
"stage_id": "ff27b57f-acd7-48d3-bcea-70395b0f0d02",
"flow_id": "ff27b57f-acd7-48d3-bcea-70395b0f0d02",
"stage_category": "Collect Data",
"stage_name": "Application"
},
"stage_id": "ff27b57f-acd7-48d3-bcea-70395b0f0d02",
"stage_category": "Collect Data",
"stage_name": "Application",
"workflow_name": "Global Business Credit Workflow",
"workflow_category": 2,
"workflow_template_id": "dc096eb5-5085-4eec-9675-314a75c89591"
},
{
"id": "000014ac-e23c-491b-8605-5111d2e1372c",
"client_tracking_token": null,
"business": {
"id": 101660,
"business_legal_name": "Today I K transport inc",
"doing_business_as": null,
"has_website": null,
"website_address": null,
"is_ecommerce": null,
"tax_exempt": null,
"preferred_contact_method": null,
"actual_monthly_revenue": null,
"estimated_annual_revenue": null,
"experian_bin": "513030667",
"duns_number": "031687357",
"finished_type": null,
"business_start_date": "2000-01-01",
"formation_state": null,
"fiscal_year_end": null,
"business_management_software": null,
"address": {
"id": 194655,
"address_line": "440 e. 3rd st",
"address_line2": null,
"country": "US",
"state": "CA",
"city": "tracy",
"zip": "95376",
"is_primary": true
},
"naics_code": null,
"sic_code": null,
"sole_owner": null,
"is_home_base": null,
"ownership_percentage": null,
"industry_type_id": null,
"sub_industry_type_id": null,
"industry_other": null,
"number_of_employees_id": null,
"business_entity_type_id": 4,
"is_codat_linked": 0,
"is_railz_linked": 0
},
"status": 1,
"closing_status_id": null,
"progress": 55,
"use_of_fund_id": null,
"is_business_credit": true,
"is_equipment_rental": false,
"is_data_capture": false,
"is_discovery_complete": false,
"finished_type": 6,
"finished_at": "2022-04-07T15:40:30.000000Z",
"amount_needed": null,
"referrer_url": null,
"source": 1,
"stips": [],
"underwriter_review_needed": false,
"naics_code": null,
"sic_code": null,
"created_at": "2022-04-07T15:40:29.000000Z",
"offers_declined_feedback": null,
"offers_declined_at": null,
"has_bank_data": false,
"stage": null,
"is_client_funded": false,
"funded_amount": null,
"stated_monthly_revenue": null,
"score_card_id": null,
"score_card_group_id": null,
"has_insurance": null,
"deal_mode": 1,
"workflow": 2,
"debts": [],
"debtors": [],
"company_officers": [],
"status_description": "Application Complete",
"salesforce": {
"link": "https://lendflow2021.lightning.force.com/lightning/r/Opportunity/0065e00000IPRXNAA5/view",
"id": "0065e00000IPRXNAA5"
},
"tracking_tokens": [],
"workflow_snapshot": {
"id": 7618,
"name": "Global Business Credit Workflow",
"type": "linear",
"widget": [
"4",
"8"
],
"status": 2,
"created_at": "2022-10-27T15:43:55.000000Z",
"updated_at": "2022-10-27T15:43:55.000000Z",
"stage_id": "ff27b57f-acd7-48d3-bcea-70395b0f0d02",
"flow_id": "ff27b57f-acd7-48d3-bcea-70395b0f0d02",
"stage_category": "Collect Data",
"stage_name": "Application"
},
"stage_id": "ff27b57f-acd7-48d3-bcea-70395b0f0d02",
"stage_category": "Collect Data",
"stage_name": "Application",
"workflow_name": "Global Business Credit Workflow",
"workflow_category": 2,
"workflow_template_id": "dc096eb5-5085-4eec-9675-314a75c89591"
}
],
"links": {
"first": "/?page=1",
"last": "/?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "/?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"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\": \"2022-12-01\",
\"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:
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=bank_statements_6" \
--form "offer_stip_id=17" \
--form "application_stip_id=17" \
--form "owner_id=17" \
--form "product_id=4" \
--form "file=@/tmp/php9EbqaL" The above command returns JSON structured like this:
{
"data": {
"id": null,
"mime_type": "image/png",
"original_name": "92fbec1e-82d1-38b4-a2e3-a0d9f7fdd61a.png",
"file_url": "",
"file_type": null,
"file_size": 140042,
"created_at": null,
"updated_at": null,
"product_id": null
}
}
Received response:
Request failed with error:
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:
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\": \"2022-12-1\",
\"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:
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:
Set or Exchange Plaid Access Token
Requires Authentication
Accepts either a plaid public token or access token. If a public token is provided, it will be exchanged for an access token.
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\",
\"is_access_token\": true
}"
The above command returns JSON structured like this:
{
"data": {
"success": true
}
}
Received response:
Request failed with error:
Save Plaid Transactions
Requires Authentication
POST
api/v2/applications/{application}/plaid/transactions
Use the following command
curl --request POST \
"https://api.lendflow.com/api/v2/applications/317fdf56-cc6d-4856-bde5-0bcb2e79b41e/plaid/transactions" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"transactions\": [
\"consequatur\"
]
}"
The above command returns JSON structured like this:
[Empty response]
Received response:
Request failed with error:
Update score-card points.
Requires Authentication
PUT
api/v2/applications/{application}/score_cards/{scoreCard}/points
Use the following command
curl --request PUT \
"https://api.lendflow.com/api/v2/applications/consequatur/score_cards/consequatur/points" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"points\": 0
}"
The above command returns JSON structured like this:
{
"data": {
"id": 1,
"status": 2,
"points": "0.00",
"weighted_points": null,
"categories": [
{
"locked": false,
"points": 100,
"backups": [],
"attribute": "experian_trades_continuously_reported_tradelines_total_account_balance",
"conditions": [
{
"type": "greater_than_or_equal",
"value": "0"
},
{
"type": "less_than_or_equal",
"value": "100"
}
],
"reverse_range": false,
"backup_applied": null,
"above_max_value": false,
"attribute_value": null,
"calculated_points": 0,
"automatic_distribution": false
}
],
"score_card_id": "1bbf6f82-66ac-4495-9e16-458bc08ac90c",
"score_card_group_result_id": null,
"score_card_status": {
"id": 242,
"name": "Manual Review",
"description": null,
"color": "#FF9F04",
"points_from": 0,
"points_to": 100,
"is_dead": false
},
"score_card_risk_tier": {
"id": 484,
"name": "Near Prime",
"description": null,
"indicator": 2,
"points_from": 0,
"points_to": 100
},
"created_at": "2022-04-29T09:46:57.000000Z",
"finished_at": "2022-04-29T09:46:57.000000Z",
"knocked_out_at": null,
"knockouts": []
}
}
Received response:
Request failed with error:
Retrieve score card results by application.
Requires Authentication
GET
api/v2/applications/{application}/score_cards/results
Use the following command
curl --request GET \
--get "https://api.lendflow.com/api/v2/applications/consequatur/score_cards/results" \
--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,
"status": 2,
"points": "0.00",
"weighted_points": null,
"categories": [
{
"locked": false,
"points": 100,
"backups": [],
"attribute": "experian_trades_continuously_reported_tradelines_total_account_balance",
"conditions": [
{
"type": "greater_than_or_equal",
"value": "0"
},
{
"type": "less_than_or_equal",
"value": "100"
}
],
"reverse_range": false,
"backup_applied": null,
"above_max_value": false,
"attribute_value": null,
"calculated_points": 0,
"automatic_distribution": false
}
],
"score_card_id": "1bbf6f82-66ac-4495-9e16-458bc08ac90c",
"score_card_group_result_id": null,
"score_card_status": {
"id": 242,
"name": "Manual Review",
"description": null,
"color": "#FF9F04",
"points_from": 0,
"points_to": 100,
"is_dead": false
},
"score_card_risk_tier": {
"id": 484,
"name": "Near Prime",
"description": null,
"indicator": 2,
"points_from": 0,
"points_to": 100
},
"created_at": "2022-04-29T09:46:57.000000Z",
"finished_at": "2022-04-29T09:46:57.000000Z",
"knocked_out_at": null,
"knockouts": []
}
}
Received response:
Request failed with error:
Retrieve score card group results by application.
Requires Authentication
GET
api/v2/applications/{application}/score_cards/group_results
Use the following command
curl --request GET \
--get "https://api.lendflow.com/api/v2/applications/consequatur/score_cards/group_results" \
--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": 6,
"points": "350.00",
"weighted_points": null,
"score_card_group_status": {
"id": 310,
"name": "Declined",
"description": null,
"color": "#FF595E",
"points_from": 301,
"points_to": 700,
"is_dead": false
},
"score_card_group_risk_tier": {
"id": 620,
"name": "Deep Prime",
"description": null,
"indicator": 5,
"points_from": 301,
"points_to": 700
},
"score_card_group_rule_status": null,
"score_card_results": [
{
"id": 39,
"status": 2,
"points": "100.00",
"weighted_points": null,
"categories": [
{
"locked": false,
"points": 100,
"backups": [],
"attribute": "experian_business_match_reliability_code",
"conditions": [
{
"type": "greater_than",
"value": "5"
}
],
"reverse_range": false,
"backup_applied": null,
"above_max_value": false,
"attribute_value": 100.3,
"calculated_points": 100,
"automatic_distribution": false
},
{
"locked": false,
"points": 100,
"backups": [],
"attribute": "ekata_person_match",
"conditions": [
{
"type": "boolean",
"value": true
}
],
"reverse_range": false,
"backup_applied": null,
"above_max_value": false,
"attribute_value": false,
"calculated_points": 0,
"automatic_distribution": false
}
],
"score_card_id": "314ff2d4-72e5-460f-9c39-b2756c84a827",
"score_card_group_result_id": 6,
"score_card_status": {
"id": 305,
"name": "Approved",
"description": null,
"color": "#06D6A0",
"points_from": 0,
"points_to": 100,
"is_dead": false
},
"score_card_risk_tier": {
"id": 610,
"name": "Super Prime",
"description": null,
"indicator": 1,
"points_from": 0,
"points_to": 100
},
"created_at": "2022-05-06T14:04:29.000000Z",
"finished_at": "2022-05-06T14:04:30.000000Z",
"knocked_out_at": null,
"knockouts": []
},
{
"id": 40,
"status": 2,
"points": "250.00",
"weighted_points": null,
"categories": [
{
"locked": false,
"points": 250,
"backups": [],
"attribute": "experian_liens",
"conditions": [
{
"type": "boolean",
"value": false
}
],
"reverse_range": false,
"backup_applied": null,
"above_max_value": false,
"attribute_value": true,
"calculated_points": 0,
"automatic_distribution": false
},
{
"locked": false,
"points": 250,
"backups": [],
"attribute": "experian_judgments",
"conditions": [
{
"type": "boolean",
"value": false
}
],
"reverse_range": false,
"backup_applied": null,
"above_max_value": false,
"attribute_value": false,
"calculated_points": 250,
"automatic_distribution": false
}
],
"score_card_id": "3fb2d3d7-a96c-4a1a-b76c-003ea5dd2628",
"score_card_group_result_id": 6,
"score_card_status": {
"id": 300,
"name": "Manual Review",
"description": null,
"color": "#FF9F04",
"points_from": 0,
"points_to": 400,
"is_dead": false
},
"score_card_risk_tier": {
"id": 598,
"name": "Super Prime",
"description": null,
"indicator": 1,
"points_from": 0,
"points_to": 300
},
"created_at": "2022-05-06T14:04:30.000000Z",
"finished_at": "2022-05-06T14:04:30.000000Z",
"knocked_out_at": null,
"knockouts": []
}
],
"created_at": "2022-05-06T14:04:29.000000Z"
}
}
Received response:
Request failed with error:
Run specific, or all, score cards against the application.
Requires Authentication
If you dont pass "score_card_ids" param, it will run all available score-cards
POST
api/v2/applications/{application}/score_cards/run
Use the following command
curl --request POST \
"https://api.lendflow.com/api/v2/applications/consequatur/score_cards/run" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"score_card_ids\": [
\"consequatur\",
\"consequatur\"
]
}"
The above command returns JSON structured like this:
{
"data": {
"started": true
}
}
Received response:
Request failed with error:
Add Debt
Requires Authentication
POST
api/v2/applications/{application}/debts
Use the following command
curl --request POST \
"https://api.lendflow.com/api/v2/applications/consequatur/debts" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"lender_name\": \"consequatur\",
\"balance_owned\": 17,
\"nature_of_debt\": 5,
\"lender_limit\": 11613.31890586,
\"maturity_date\": \"2022-12-01T20:29:39\"
}"
The above command returns JSON structured like this:
{
"data": {
"id": 1,
"lender_name": "Parkes & Sons 3",
"balance_owned": 40,
"nature_of_debt": 4,
"lender_limit": null,
"maturity_date": null
}
}
Received response:
Request failed with error:
Update Debt
Requires Authentication
PUT
api/v2/applications/{application}/debts/{id}
PATCH
api/v2/applications/{application}/debts/{id}
Use the following command
curl --request PUT \
"https://api.lendflow.com/api/v2/applications/consequatur/debts/17" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"lender_name\": \"consequatur\",
\"balance_owned\": 17,
\"nature_of_debt\": 5,
\"lender_limit\": 11613.31890586,
\"maturity_date\": \"2022-12-01T20:29:39\"
}"
The above command returns JSON structured like this:
{
"data": {
"id": null,
"lender_name": "Grady and Sons",
"balance_owned": 351,
"nature_of_debt": 1,
"lender_limit": 1393,
"maturity_date": "2023-01-15T00:00:00.000000Z"
}
}
Received response:
Request failed with error:
Add Debtor
Requires Authentication
POST
api/v2/applications/{application}/debtors
Use the following command
curl --request POST \
"https://api.lendflow.com/api/v2/applications/consequatur/debtors" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"business_name\": \"consequatur\",
\"amount\": 17,
\"payment_term\": 17
}"
The above command returns JSON structured like this:
{
"data": {
"id": 1,
"business_name": "Foxy 2",
"amount": 32,
"payment_term": 43
}
}
Received response:
Request failed with error:
Update Debtor
Requires Authentication
PUT
api/v2/applications/{application}/debtors/{id}
PATCH
api/v2/applications/{application}/debtors/{id}
Use the following command
curl --request PUT \
"https://api.lendflow.com/api/v2/applications/consequatur/debtors/17" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"business_name\": \"consequatur\",
\"amount\": 17,
\"payment_term\": 17
}"
The above command returns JSON structured like this:
{
"data": {
"id": 1,
"business_name": "Foxy 2",
"amount": 32,
"payment_term": 43
}
}
Received response:
Request failed with error:
Add Company Officer
Requires Authentication
POST
api/v2/applications/{application}/company_officers
Use the following command
curl --request POST \
"https://api.lendflow.com/api/v2/applications/consequatur/company_officers" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"consequatur\",
\"first_name\": \"consequatur\",
\"last_name\": \"consequatur\",
\"email\": \"qkunze@example.com\"
}"
The above command returns JSON structured like this:
{
"data": {
"id": null,
"title": "Prof.",
"first_name": "Charity",
"last_name": "Schultz",
"email": "edd82fb4-33c6-3f3e-9585-5d16cbef8718@example.com"
}
}
Received response:
Request failed with error:
Update Company Officer
Requires Authentication
PUT
api/v2/applications/{application}/company_officers/{id}
PATCH
api/v2/applications/{application}/company_officers/{id}
Use the following command
curl --request PUT \
"https://api.lendflow.com/api/v2/applications/consequatur/company_officers/17" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"consequatur\",
\"first_name\": \"consequatur\",
\"last_name\": \"consequatur\",
\"email\": \"qkunze@example.com\"
}"
The above command returns JSON structured like this:
{
"data": {
"id": null,
"title": "Prof.",
"first_name": "Charity",
"last_name": "Schultz",
"email": "edd82fb4-33c6-3f3e-9585-5d16cbef8718@example.com"
}
}
Received response:
Request failed with error:
Update Application Stips
Requires Authentication
PUT
api/v2/applications/{application}/stips
Use the following command
curl --request PUT \
"https://api.lendflow.com/api/v2/applications/consequatur/stips" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"stips\": [
{
\"description\": \"consequatur\"
}
]
}"
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 required stips for single application
Requires Authentication
GET
api/v2/applications/{application}/required-stips
Use the following command
curl --request GET \
--get "https://api.lendflow.com/api/v2/applications/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:
Update the application's assigned users (Underwriter, Analyst, etc.)
Requires Authentication
PUT
api/v2/applications/{application}/assignment
Use the following command
curl --request PUT \
"https://api.lendflow.com/api/v2/applications/consequatur/assignment" \
--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": "c70eae2c-1f77-4f3b-b6fe-fc3d0eb1cf5a"
}
}
Received response:
Request failed with error:
Show a sample payload that the user can use as a template/guide when submitting data to update an application.
Requires Authentication
GET
api/v2/applications/{application}/workflow/sample
Use the following command
curl --request GET \
--get "https://api.lendflow.com/api/v2/applications/consequatur/workflow/sample" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Received response:
Request failed with error:
Show a sample payload that the user can use as a template/guide when submitting data to update an application.
Requires Authentication
GET
api/v2/workflow/{template}/sample
Use the following command
curl --request GET \
--get "https://api.lendflow.com/api/v2/workflow/consequatur/sample" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Received response:
Request failed with error:
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:
Update Offer Status
Requires Authentication
PUT
api/v2/offers/{offer}/status
Use the following command
curl --request PUT \
"https://api.lendflow.com/api/v2/offers/317fdf56-cc6d-4856-bde5-0bcb2e79b41e/status" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"status\": 1
}"
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": "00036d3d-994a-4e78-b344-964e3cd415a2",
"application_id": "1548d11a-9c4e-4e78-a14e-5243a7c40b74",
"start_date": null,
"end_date": null,
"product": "Receivables Purchase",
"offer_amount": 50000,
"payback_amount": 63000,
"payment_amount": 1666.65,
"number_of_payments": 36,
"max_sell_factor_rate": 1.26,
"min_buy_factor_rate": 1.17,
"payment_frequency": 2,
"term_length": 9,
"offer_generated_date": "2022-06-14T15:16:00.000000Z",
"offer_expiration_date": "2022-06-28T00:00:00.000000Z",
"max_commission_rate": 9,
"status": 2
}
}
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": "00036d3d-994a-4e78-b344-964e3cd415a2",
"application_id": "1548d11a-9c4e-4e78-a14e-5243a7c40b74",
"start_date": null,
"end_date": null,
"product": "Receivables Purchase",
"offer_amount": 50000,
"payback_amount": 63000,
"payment_amount": 1666.65,
"number_of_payments": 36,
"max_sell_factor_rate": 1.26,
"min_buy_factor_rate": 1.17,
"payment_frequency": 2,
"term_length": 9,
"offer_generated_date": "2022-06-14T15:16:00.000000Z",
"offer_expiration_date": "2022-06-28T00:00:00.000000Z",
"max_commission_rate": 9,
"status": 2
},
{
"id": "00036d3d-994a-4e78-b344-964e3cd415a2",
"application_id": "1548d11a-9c4e-4e78-a14e-5243a7c40b74",
"start_date": null,
"end_date": null,
"product": "Receivables Purchase",
"offer_amount": 50000,
"payback_amount": 63000,
"payment_amount": 1666.65,
"number_of_payments": 36,
"max_sell_factor_rate": 1.26,
"min_buy_factor_rate": 1.17,
"payment_frequency": 2,
"term_length": 9,
"offer_generated_date": "2022-06-14T15:16:00.000000Z",
"offer_expiration_date": "2022-06-28T00:00:00.000000Z",
"max_commission_rate": 9,
"status": 2
}
]
}
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": null,
"range": null
},
{
"key": null,
"range": null
}
]
}
Received response:
Request failed with error:
Available Data Orchestration Templates
Requires Authentication
Lists published data orchestration templates.
GET
api/v2/data_orchestration/templates
Use the following command
curl --request GET \
--get "https://api.lendflow.com/api/v2/data_orchestration/templates" \
--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": "c16771bc-fd85-4500-9319-fcf10647d483",
"short_id": "c1677",
"name": "Dolores.",
"description": "Veniam sed fuga aspernatur natus earum. Dignissimos perferendis voluptatibus incidunt nostrum quia possimus. Id et necessitatibus architecto aut consequatur debitis.",
"workflow": [
"funding"
],
"trigger": null,
"created_at": "2022-12-01T20:29:40.000000Z",
"updated_at": "2022-12-01T20:29:40.000000Z"
},
{
"id": "9da68dca-fce5-4076-aa88-6c864e70c36b",
"short_id": "9da68",
"name": "A qui.",
"description": "Nihil autem omnis cum molestiae vel. Ex dicta hic inventore asperiores illum est. Non quia dicta in. Provident qui a voluptatem dignissimos error sit labore quos.",
"workflow": [
"funding"
],
"trigger": null,
"created_at": "2022-12-01T20:29:40.000000Z",
"updated_at": "2022-12-01T20:29:40.000000Z"
}
]
}
Received response:
Request failed with error:
Run Data Orchestration for an Application
Requires Authentication
Run data orchestration given a specific template ID and application ID.
POST
api/v2/data_orchestration/execute
Use the following command
curl --request POST \
"https://api.lendflow.com/api/v2/data_orchestration/execute" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"template_id\": \"consequatur\",
\"application_id\": \"consequatur\"
}"
The above command returns JSON structured like this:
[Empty response]
Received response:
Request failed with error:
Available Workflow Builder Templates
Requires Authentication
Lists all workflow builder templates that the user has access to.
GET
api/v2/workflow_templates
Use the following command
curl --request GET \
--get "https://api.lendflow.com/api/v2/workflow_templates" \
--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": "fb61e0b2-45b0-4551-be21-c7f9028f5189",
"short_id": "fb61e",
"name": "Dr. Enid Harber II",
"description": "Id totam temporibus quia ipsam ut. Iusto accusamus iusto similique accusantium et. Qui ducimus nihil laudantium nihil autem omnis cum molestiae.",
"type": "linear",
"widget": [
1,
10
],
"status": 2,
"is_active": null,
"is_global": false,
"created_at": "2022-12-01T20:29:40.000000Z",
"updated_at": "2022-12-01T20:29:40.000000Z"
},
{
"id": "3c8f67b4-2938-45b5-bf7d-733068f18883",
"short_id": "3c8f6",
"name": "Vladimir Hirthe",
"description": "Odit aut voluptas quasi ut. Culpa reiciendis totam est consequatur doloribus optio est. Hic eum qui sint laudantium fuga dolorem.",
"type": "linear",
"widget": [
1,
10
],
"status": 2,
"is_active": null,
"is_global": false,
"created_at": "2022-12-01T20:29:40.000000Z",
"updated_at": "2022-12-01T20:29:40.000000Z"
}
]
}
Received response:
Request failed with error:
Get Integration Snippet/Application Link
Requires Authentication
This endpoint, generate integration code
GET
api/v2/integration
Use the following command
curl --request GET \
--get "https://api.lendflow.com/api/v2/integration?product_type=17&widget_brand_id=17&email_brand_id=17&workflow=17&is_advance_mode=&is_link=&custom_sub_domain=consequatur" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"The above command returns JSON structured like this:
<code snippet>
Received response:
Request failed with error:
List all score-cards.
Requires Authentication
GET
api/v2/score_cards
Use the following command
curl --request GET \
--get "https://api.lendflow.com/api/v2/score_cards?search=consequatur&sort_by=17" \
--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": "01395903-6bc2-4f58-ace1-11620894d243",
"name": "TA - Test",
"description": null,
"status": 1,
"type": 2,
"borrower_type": null,
"points": null,
"content": null,
"product_type_id": null,
"client_id": null,
"created_at": "2022-06-23T17:51:40.000000Z",
"results": []
},
{
"id": "01395903-6bc2-4f58-ace1-11620894d243",
"name": "TA - Test",
"description": null,
"status": 1,
"type": 2,
"borrower_type": null,
"points": null,
"content": null,
"product_type_id": null,
"client_id": null,
"created_at": "2022-06-23T17:51:40.000000Z",
"results": []
}
],
"links": {
"first": "/?page=1",
"last": "/?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "/?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "/",
"per_page": "100",
"to": 2,
"total": 2
}
}
Received response:
Request failed with error:
Get specific score-card details.
Requires Authentication
GET
api/v2/score_cards/{scoreCard}
Use the following command
curl --request GET \
--get "https://api.lendflow.com/api/v2/score_cards/consequatur" \
--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": "01395903-6bc2-4f58-ace1-11620894d243",
"name": "TA - Test",
"description": null,
"status": 1,
"type": 2,
"borrower_type": null,
"points": null,
"content": null,
"product_type_id": null,
"client_id": null,
"created_at": "2022-06-23T17:51:40.000000Z",
"results": []
}
}
Received response:
Request failed with error:
Add Attribute Template Custom Value
Requires Authentication
Provide custom value for api type attribute template and linked it to an application
POST
api/v2/attributes/{attribute}/value
Use the following command
curl --request POST \
"https://api.lendflow.com/api/v2/attributes/consequatur/value" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"value\": 11613.31890586,
\"application_id\": \"consequatur\"
}"
The above command returns JSON structured like this:
{
"data": [
{
"id": 1,
"value": "1",
"source": 1,
"application_id": "28d7bc4c-a22b-4186-a7aa-f59a9d84a039",
"updated_at": "2022-10-11T15:31:39.000000Z",
"created_at": "2022-10-11T15:31:39.000000Z"
},
{
"id": null,
"value": 345083,
"source": 1,
"application_id": "ab15149b-ffc9-4b23-8e15-3ab414debac4",
"updated_at": null,
"created_at": null
}
]
}
Received response:
Request failed with error:
Create new profile.
Requires Authentication
POST
api/v2/profiles
Use the following command
curl --request POST \
"https://api.lendflow.com/api/v2/profiles" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"type\": \"business\",
\"client_tracking_token\": \"vmqeopfuudtdsufvyvddqamniihfqcoynlazghdtq\"
}"
The above command returns JSON structured like this:
{
"data": {
"id": "41e8f482-3df5-4643-b47c-2af110b37ae4",
"client_tracking_token": null,
"type": "business",
"name": "Klein-Moen",
"is_for_client": false
}
}
Received response:
Request failed with error:
Update profile.
Requires Authentication
PUT
api/v2/profiles/{profile_type}/{profile_id}
Use the following command
curl --request PUT \
"https://api.lendflow.com/api/v2/profiles/consequatur/consequatur" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"client_tracking_token\": \"vmqeopfuudtdsufvyvddqamniihfqcoynlazghdtq\"
}"
The above command returns JSON structured like this:
{
"data": {
"id": "cc3b75c2-90f3-42d8-8c1c-f1fc415519f6",
"client_tracking_token": null,
"type": "business",
"name": "Klein-Moen",
"is_for_client": false
}
}
Received response:
Request failed with error:
Retrieve Email Customizations
Requires Authentication
List all email customization templates available
GET
api/v2/email_customization
Use the following command
curl --request GET \
--get "https://api.lendflow.com/api/v2/email_customization" \
--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,
"template_name": "testtemplateprd-101-edited",
"logo_url": "https://api.lendflow.com/images/lendflow_logo_widget.svg",
"header_primary_color": "#006600",
"footer_business_address": "QA Test Business Address 101 edited",
"footer_business_phone": "5124560102",
"active": 1,
"header_image": null,
"header_text_color": null,
"facebook_url": null,
"twitter_url": null,
"linkedin_url": null
},
{
"id": 1,
"template_name": "testtemplateprd-101-edited",
"logo_url": "https://api.lendflow.com/images/lendflow_logo_widget.svg",
"header_primary_color": "#006600",
"footer_business_address": "QA Test Business Address 101 edited",
"footer_business_phone": "5124560102",
"active": 1,
"header_image": null,
"header_text_color": null,
"facebook_url": null,
"twitter_url": null,
"linkedin_url": null
}
],
"links": {
"first": "/?page=1",
"last": "/?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "/?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "/",
"per_page": "15",
"to": 2,
"total": 2
}
}
Received response:
Request failed with error:
Create Email Customization
Requires Authentication
Create a new email customization template
POST
api/v2/email_customization
Use the following command
curl --request POST \
"https://api.lendflow.com/api/v2/email_customization" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"template_name\": \"consequatur\",
\"footer_business_address\": \"consequatur\",
\"header_text_color\": \"consequatur\",
\"linkedin_url\": \"http:\\/\\/kunze.biz\\/iste-laborum-eius-est-dolor.html\",
\"twitter_url\": \"http:\\/\\/kunze.biz\\/iste-laborum-eius-est-dolor.html\",
\"facebook_url\": \"http:\\/\\/kunze.biz\\/iste-laborum-eius-est-dolor.html\"
}"
The above command returns JSON structured like this:
{
"data": {
"id": 1,
"template_name": "testtemplateprd-101-edited",
"logo_url": "https://api.lendflow.com/images/lendflow_logo_widget.svg",
"header_primary_color": "#006600",
"footer_business_address": "QA Test Business Address 101 edited",
"footer_business_phone": "5124560102",
"active": 1,
"header_image": null,
"header_text_color": null,
"facebook_url": null,
"twitter_url": null,
"linkedin_url": null
}
}
Received response:
Request failed with error:
Retrieve single Email Customization
Requires Authentication
Get details for an email customization
GET
api/v2/email_customization/{id}
Use the following command
curl --request GET \
--get "https://api.lendflow.com/api/v2/email_customization/consequatur" \
--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,
"template_name": "testtemplateprd-101-edited",
"logo_url": "https://api.lendflow.com/images/lendflow_logo_widget.svg",
"header_primary_color": "#006600",
"footer_business_address": "QA Test Business Address 101 edited",
"footer_business_phone": "5124560102",
"active": 1,
"header_image": null,
"header_text_color": null,
"facebook_url": null,
"twitter_url": null,
"linkedin_url": null
}
}
Received response:
Request failed with error:
Update Email Customization
Requires Authentication
Update am email customization template
PUT
api/v2/email_customization/{id}
PATCH
api/v2/email_customization/{id}
Use the following command
curl --request PUT \
"https://api.lendflow.com/api/v2/email_customization/17" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"template_name\": \"consequatur\",
\"footer_business_address\": \"consequatur\",
\"header_text_color\": \"consequatur\",
\"linkedin_url\": \"http:\\/\\/kunze.biz\\/iste-laborum-eius-est-dolor.html\",
\"twitter_url\": \"http:\\/\\/kunze.biz\\/iste-laborum-eius-est-dolor.html\",
\"facebook_url\": \"http:\\/\\/kunze.biz\\/iste-laborum-eius-est-dolor.html\"
}"
The above command returns JSON structured like this:
{
"data": {
"id": 1,
"template_name": "testtemplateprd-101-edited",
"logo_url": "https://api.lendflow.com/images/lendflow_logo_widget.svg",
"header_primary_color": "#006600",
"footer_business_address": "QA Test Business Address 101 edited",
"footer_business_phone": "5124560102",
"active": 1,
"header_image": null,
"header_text_color": null,
"facebook_url": null,
"twitter_url": null,
"linkedin_url": null
}
}
Received response:
Request failed with error:
Delete Email Customization
Requires Authentication
Delete an existing email customization
DELETE
api/v2/email_customization/{id}
Use the following command
curl --request DELETE \
"https://api.lendflow.com/api/v2/email_customization/17" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Received response:
Request failed with error:
Upload Email Customization Image
Requires Authentication
Upload logo and/or headerImage for email customization template
POST
api/v2/email_customization/{emailCustomization_id}/upload
Use the following command
curl --request POST \
"https://api.lendflow.com/api/v2/email_customization/consequatur/upload" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--form "logo=@/tmp/phpXecsHK" \
--form "header_image=@/tmp/php6YBywL" The above command returns JSON structured like this:
{
"data": {
"success": true
}
}
Received response:
Request failed with error:
Delete Logo (Email Customization)
Requires Authentication
Delete the logo of email an customization template
DELETE
api/v2/email_customization/{emailCustomization_id}/logo
Use the following command
curl --request DELETE \
"https://api.lendflow.com/api/v2/email_customization/consequatur/logo" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Received response:
Request failed with error:
Delete Header Image (Email Customization)
Requires Authentication
Delete header email from an email customization template
DELETE
api/v2/email_customization/{emailCustomization_id}/header_image
Use the following command
curl --request DELETE \
"https://api.lendflow.com/api/v2/email_customization/consequatur/header_image" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Received response:
Request failed with error:
Get Widget Templates
Requires Authentication
Get the list of widget templates
GET
api/v2/widget_templates
Use the following command
curl --request GET \
--get "https://api.lendflow.com/api/v2/widget_templates" \
--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,
"name": "Template 1",
"is_default": true,
"colour": "#0D8AFF",
"button_colour": "#1790E7",
"button_text_colour": "#1CFFFF",
"heading_font_colour": "#FFFBE6",
"description_font_colour": "#000000",
"label_font_colour": "#000000",
"icon_colour": "#F5FFF2",
"progress_bar_colour": "#04FE72",
"display_pre_qualifications": true,
"currency": "usd",
"locale": "en-US",
"logo": {
"id": null,
"file_url": "https://api.lendflow.com/images/lendflow_icon.png",
"original_name": "Lendflow.png"
}
},
{
"id": 1,
"name": "Template 1",
"is_default": true,
"colour": "#0D8AFF",
"button_colour": "#1790E7",
"button_text_colour": "#1CFFFF",
"heading_font_colour": "#FFFBE6",
"description_font_colour": "#000000",
"label_font_colour": "#000000",
"icon_colour": "#F5FFF2",
"progress_bar_colour": "#04FE72",
"display_pre_qualifications": true,
"currency": "usd",
"locale": "en-US",
"logo": {
"id": null,
"file_url": "https://api.lendflow.com/images/lendflow_icon.png",
"original_name": "Lendflow.png"
}
}
]
}
Received response:
Request failed with error:
Create Widget Template
Requires Authentication
Create Template for application widget.
POST
api/v2/widget_templates
Use the following command
curl --request POST \
"https://api.lendflow.com/api/v2/widget_templates" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"consequatur\",
\"is_default\": true,
\"colour\": \"#272A40\",
\"button_text_colour\": \"\\\"#FFFFFF\",
\"button_colour\": \"#4476E5\",
\"heading_font_colour\": \"#4476E5\",
\"description_font_colour\": \"#7587A0\",
\"label_font_colour\": \"#545464\",
\"icon_colour\": \"#FFFFFF\",
\"progress_bar_colour\": \"#04FE72\"
}"
The above command returns JSON structured like this:
{
"data": {
"id": 1,
"name": "Template 1",
"is_default": true,
"colour": "#0D8AFF",
"button_colour": "#1790E7",
"button_text_colour": "#1CFFFF",
"heading_font_colour": "#FFFBE6",
"description_font_colour": "#000000",
"label_font_colour": "#000000",
"icon_colour": "#F5FFF2",
"progress_bar_colour": "#04FE72",
"display_pre_qualifications": true,
"currency": "usd",
"locale": "en-US",
"logo": {
"id": null,
"file_url": "https://api.lendflow.com/images/lendflow_icon.png",
"original_name": "Lendflow.png"
}
}
}
Received response:
Request failed with error:
Get single Widget Template
Requires Authentication
GET
api/v2/widget_templates/{id}
Use the following command
curl --request GET \
--get "https://api.lendflow.com/api/v2/widget_templates/17" \
--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,
"name": "Template 1",
"is_default": true,
"colour": "#0D8AFF",
"button_colour": "#1790E7",
"button_text_colour": "#1CFFFF",
"heading_font_colour": "#FFFBE6",
"description_font_colour": "#000000",
"label_font_colour": "#000000",
"icon_colour": "#F5FFF2",
"progress_bar_colour": "#04FE72",
"display_pre_qualifications": true,
"currency": "usd",
"locale": "en-US",
"logo": {
"id": null,
"file_url": "https://api.lendflow.com/images/lendflow_icon.png",
"original_name": "Lendflow.png"
}
}
}
Received response:
Request failed with error:
Update Widget Template
Requires Authentication
PUT
api/v2/widget_templates/{id}
PATCH
api/v2/widget_templates/{id}
Use the following command
curl --request PUT \
"https://api.lendflow.com/api/v2/widget_templates/17" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"consequatur\",
\"is_default\": true,
\"colour\": \"#272A40\",
\"button_text_colour\": \"\\\"#FFFFFF\",
\"button_colour\": \"#4476E5\",
\"heading_font_colour\": \"#4476E5\",
\"description_font_colour\": \"#7587A0\",
\"label_font_colour\": \"#545464\",
\"icon_colour\": \"#FFFFFF\",
\"progress_bar_colour\": \"#04FE72\"
}"
The above command returns JSON structured like this:
{
"data": {
"id": 1,
"name": "Template 1",
"is_default": true,
"colour": "#0D8AFF",
"button_colour": "#1790E7",
"button_text_colour": "#1CFFFF",
"heading_font_colour": "#FFFBE6",
"description_font_colour": "#000000",
"label_font_colour": "#000000",
"icon_colour": "#F5FFF2",
"progress_bar_colour": "#04FE72",
"display_pre_qualifications": true,
"currency": "usd",
"locale": "en-US",
"logo": {
"id": null,
"file_url": "https://api.lendflow.com/images/lendflow_icon.png",
"original_name": "Lendflow.png"
}
}
}
Received response:
Request failed with error:
Delete Widget Template
Requires Authentication
DELETE
api/v2/widget_templates/{id}
Use the following command
curl --request DELETE \
"https://api.lendflow.com/api/v2/widget_templates/17" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Received response:
Request failed with error:
Upload Widget Template Logo
Requires Authentication
Upload widget logo from specific widget template
POST
api/v2/widget_templates/{widgetTemplate_id}/logo
Use the following command
curl --request POST \
"https://api.lendflow.com/api/v2/widget_templates/consequatur/logo" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--form "file=@/tmp/phpGaDs6H" 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:
Delete Widget Logo
Requires Authentication
Delete widget logo from a specific widget template
DELETE
api/v2/widget_templates/{widgetTemplate_id}/logo
Use the following command
curl --request DELETE \
"https://api.lendflow.com/api/v2/widget_templates/consequatur/logo" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Received response:
Request failed with error:
Dashboard
Run specific (or all) score card groups against Deal
Requires Authentication
If you dont pass "score_card_group_ids" param, it will run all available score-cards
POST
api/v2/applications/{application}/score_card_groups/run
Use the following command
curl --request POST \
"https://api.lendflow.com/api/v2/applications/consequatur/score_card_groups/run" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"score_card_group_ids\": [
\"consequatur\"
]
}"
The above command returns JSON structured like this:
{
"data": {
"started": true
}
}
Received response:
Request failed with error: