curl --request GET \
--url https://api.lendflow.com/api/applications/{application_id}/workflow/sample \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"schema_version": "3.56.0"
}
'import requests
url = "https://api.lendflow.com/api/applications/{application_id}/workflow/sample"
payload = { "schema_version": "3.56.0" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({schema_version: '3.56.0'})
};
fetch('https://api.lendflow.com/api/applications/{application_id}/workflow/sample', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.lendflow.com/api/applications/{application_id}/workflow/sample",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'schema_version' => '3.56.0'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.lendflow.com/api/applications/{application_id}/workflow/sample"
payload := strings.NewReader("{\n \"schema_version\": \"3.56.0\"\n}")
req, _ := http.NewRequest("GET", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.lendflow.com/api/applications/{application_id}/workflow/sample")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"schema_version\": \"3.56.0\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lendflow.com/api/applications/{application_id}/workflow/sample")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"schema_version\": \"3.56.0\"\n}"
response = http.request(request)
puts response.read_body{"data":{"\u0000*\u0000connection":null,"\u0000*\u0000table":null,"\u0000*\u0000primaryKey":"id","\u0000*\u0000keyType":"int","incrementing":true,"\u0000*\u0000with":[],"\u0000*\u0000withCount":[],"preventsLazyLoading":false,"\u0000*\u0000perPage":15,"exists":false,"wasRecentlyCreated":false,"\u0000*\u0000escapeWhenCastingToString":false,"\u0000*\u0000attributes":{"user_id":1667,"business_id":906,"is_business_credit":false,"workflow":1,"deal_mode":1},"\u0000*\u0000original":[],"\u0000*\u0000changes":[],"\u0000*\u0000previous":[],"\u0000*\u0000casts":{"has_inventory":"boolean","has_subscriptions":"boolean","has_outstanding_debt":"boolean","total_average_debt":"float","has_tax_return":"boolean","has_payroll_software":"boolean","estimated_personal_income":"float","total_dept":"float","underwriter_review_needed":"boolean","is_business_credit":"boolean","is_equipment_rental":"boolean","is_invoice_factoring":"boolean","is_invoice_factoring_codat":"boolean","is_no_prequal_docu_plaid":"boolean","is_no_prequal_docu":"boolean","is_lending_no_prequal_personal_info":"boolean","is_data_capture":"boolean","is_discovery_complete":"boolean","amount_needed":"float","offers_declined_at":"datetime","finished_at":"datetime","underwriter_updated_at":"datetime","funding_advisor_updated_at":"datetime","analyst_updated_at":"datetime","is_client_funded":"boolean","has_insurance":"boolean","scout_last_import_datetime":"datetime","widget_type":"App\\Models\\Enums\\WidgetType","widget_destination":"array","workflow_segment":"App\\Services\\WorkflowBuilder\\Enums\\WorkflowSegment","priority":"App\\Enums\\Priority","deleted_at":"datetime"},"\u0000*\u0000classCastCache":[],"\u0000*\u0000attributeCastCache":[],"\u0000*\u0000dateFormat":null,"\u0000*\u0000appends":[],"\u0000*\u0000dispatchesEvents":[],"\u0000*\u0000observables":[],"\u0000*\u0000relations":[],"\u0000*\u0000touches":[],"\u0000*\u0000relationAutoloadCallback":null,"\u0000*\u0000relationAutoloadContext":null,"timestamps":true,"usesUniqueIds":false,"\u0000*\u0000hidden":[],"\u0000*\u0000visible":[],"\u0000*\u0000fillable":["prequalification_id","business_id","client_id","referrer_absolute_url","has_inventory","inventory_id","has_subscriptions","total_average_debt","has_outstanding_debt","use_of_fund_id","funds_needed_time_id","has_tax_return","has_payroll_software","total_dept","estimated_personal_income","stage","user_id","amount_needed","sales_representative_id","source","analyst_id","underwriter_id","funding_advisor_id","client_analyst_id","client_underwriter_id","client_funding_advisor_id","underwriter_review_needed","branding_id","brand_name_id","email_template_id","is_business_credit","is_equipment_rental","is_invoice_factoring","is_invoice_factoring_codat","is_no_prequal_docu_plaid","is_no_prequal_docu","is_lending_no_prequal_personal_info","is_data_capture","is_discovery_complete","primary_bank_account_id","offers_declined_feedback","offers_declined_at","client_tracking_token","finished_at","funding_advisor_updated_at","underwriter_updated_at","analyst_updated_at","is_client_funded","import_id","has_insurance","deal_mode","workflow","score_card_id","score_card_group_id","reference_application_id","finished_type","widget_type","widget_destination","docusign_placeholder_id","widget_link","requested_workflow_template_id","status","contract_template_id","consent_template_id","workflow_segment","priority"],"\u0000*\u0000guarded":["*"],"\u0000*\u0000scoutMetadata":[],"\u0000App\\Models\\Application\u0000relatedApplications":null,"\u0000App\\Models\\Application\u0000latestExternalServiceLogs":null,"\u0000*\u0000cascadeRelationships":["accountingData","activityFeedEntries","aiAgentSessions","affiliatedBusinesses","applicationReferrerHost","applicationStips","assets","bankAccountDetails","bankAccounts","billingInformation","bondingAgent","borrowerPlatformUrlVisits","callSessions","commerceData","communicationEmails","companyOfficers","attributeValues","death","debts","debtors","discoveryCallAnswers","documentVerifications","enrichment","enrichmentMetadata","equipmentDetails","equipmentRentalApproval","estimatedSpendAmount","externalServiceLogs","fileables","fundingAdvisorLogs","guarantor","insurance","isoUpload","kycValidations","legacyMigration","loanProviders","mailLogs","mailLoggables","metadata","moneyThumbBook","notes","oauthTokens","ocrolusBooks","offers","orchestrationLogs","payrollReportStatements","payrolls","phoneValidations","placements","plaid","plaidBankAccounts","plaidBankData","pnl","pnlTransactions","prequalification","productsRequested","receivables","resumeCode","scoreCardGroupResults","scoreCardResults","sentInactivityNotifications","smsLogs","stageLogs","statusLogs","suspiciousActivities","tasks","trackingTokens","underwritingLogs","utmParameters","widgetLogs","widgetSessions","workflowOrchestrationLogs","workflowSnapshot","workflowStatusLogs","properties"],"\u0000*\u0000oldAttributes":[],"enableLoggingModelsEvents":true,"\u0000*\u0000forceDeleting":false,"\u0000*\u0000clearResponseCache":true}}Sample Payload - Workflow
Show a sample payload that the user can use as a template/guide when submitting data to update an application.
curl --request GET \
--url https://api.lendflow.com/api/applications/{application_id}/workflow/sample \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"schema_version": "3.56.0"
}
'import requests
url = "https://api.lendflow.com/api/applications/{application_id}/workflow/sample"
payload = { "schema_version": "3.56.0" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({schema_version: '3.56.0'})
};
fetch('https://api.lendflow.com/api/applications/{application_id}/workflow/sample', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.lendflow.com/api/applications/{application_id}/workflow/sample",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'schema_version' => '3.56.0'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.lendflow.com/api/applications/{application_id}/workflow/sample"
payload := strings.NewReader("{\n \"schema_version\": \"3.56.0\"\n}")
req, _ := http.NewRequest("GET", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.lendflow.com/api/applications/{application_id}/workflow/sample")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"schema_version\": \"3.56.0\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lendflow.com/api/applications/{application_id}/workflow/sample")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"schema_version\": \"3.56.0\"\n}"
response = http.request(request)
puts response.read_body{"data":{"\u0000*\u0000connection":null,"\u0000*\u0000table":null,"\u0000*\u0000primaryKey":"id","\u0000*\u0000keyType":"int","incrementing":true,"\u0000*\u0000with":[],"\u0000*\u0000withCount":[],"preventsLazyLoading":false,"\u0000*\u0000perPage":15,"exists":false,"wasRecentlyCreated":false,"\u0000*\u0000escapeWhenCastingToString":false,"\u0000*\u0000attributes":{"user_id":1667,"business_id":906,"is_business_credit":false,"workflow":1,"deal_mode":1},"\u0000*\u0000original":[],"\u0000*\u0000changes":[],"\u0000*\u0000previous":[],"\u0000*\u0000casts":{"has_inventory":"boolean","has_subscriptions":"boolean","has_outstanding_debt":"boolean","total_average_debt":"float","has_tax_return":"boolean","has_payroll_software":"boolean","estimated_personal_income":"float","total_dept":"float","underwriter_review_needed":"boolean","is_business_credit":"boolean","is_equipment_rental":"boolean","is_invoice_factoring":"boolean","is_invoice_factoring_codat":"boolean","is_no_prequal_docu_plaid":"boolean","is_no_prequal_docu":"boolean","is_lending_no_prequal_personal_info":"boolean","is_data_capture":"boolean","is_discovery_complete":"boolean","amount_needed":"float","offers_declined_at":"datetime","finished_at":"datetime","underwriter_updated_at":"datetime","funding_advisor_updated_at":"datetime","analyst_updated_at":"datetime","is_client_funded":"boolean","has_insurance":"boolean","scout_last_import_datetime":"datetime","widget_type":"App\\Models\\Enums\\WidgetType","widget_destination":"array","workflow_segment":"App\\Services\\WorkflowBuilder\\Enums\\WorkflowSegment","priority":"App\\Enums\\Priority","deleted_at":"datetime"},"\u0000*\u0000classCastCache":[],"\u0000*\u0000attributeCastCache":[],"\u0000*\u0000dateFormat":null,"\u0000*\u0000appends":[],"\u0000*\u0000dispatchesEvents":[],"\u0000*\u0000observables":[],"\u0000*\u0000relations":[],"\u0000*\u0000touches":[],"\u0000*\u0000relationAutoloadCallback":null,"\u0000*\u0000relationAutoloadContext":null,"timestamps":true,"usesUniqueIds":false,"\u0000*\u0000hidden":[],"\u0000*\u0000visible":[],"\u0000*\u0000fillable":["prequalification_id","business_id","client_id","referrer_absolute_url","has_inventory","inventory_id","has_subscriptions","total_average_debt","has_outstanding_debt","use_of_fund_id","funds_needed_time_id","has_tax_return","has_payroll_software","total_dept","estimated_personal_income","stage","user_id","amount_needed","sales_representative_id","source","analyst_id","underwriter_id","funding_advisor_id","client_analyst_id","client_underwriter_id","client_funding_advisor_id","underwriter_review_needed","branding_id","brand_name_id","email_template_id","is_business_credit","is_equipment_rental","is_invoice_factoring","is_invoice_factoring_codat","is_no_prequal_docu_plaid","is_no_prequal_docu","is_lending_no_prequal_personal_info","is_data_capture","is_discovery_complete","primary_bank_account_id","offers_declined_feedback","offers_declined_at","client_tracking_token","finished_at","funding_advisor_updated_at","underwriter_updated_at","analyst_updated_at","is_client_funded","import_id","has_insurance","deal_mode","workflow","score_card_id","score_card_group_id","reference_application_id","finished_type","widget_type","widget_destination","docusign_placeholder_id","widget_link","requested_workflow_template_id","status","contract_template_id","consent_template_id","workflow_segment","priority"],"\u0000*\u0000guarded":["*"],"\u0000*\u0000scoutMetadata":[],"\u0000App\\Models\\Application\u0000relatedApplications":null,"\u0000App\\Models\\Application\u0000latestExternalServiceLogs":null,"\u0000*\u0000cascadeRelationships":["accountingData","activityFeedEntries","aiAgentSessions","affiliatedBusinesses","applicationReferrerHost","applicationStips","assets","bankAccountDetails","bankAccounts","billingInformation","bondingAgent","borrowerPlatformUrlVisits","callSessions","commerceData","communicationEmails","companyOfficers","attributeValues","death","debts","debtors","discoveryCallAnswers","documentVerifications","enrichment","enrichmentMetadata","equipmentDetails","equipmentRentalApproval","estimatedSpendAmount","externalServiceLogs","fileables","fundingAdvisorLogs","guarantor","insurance","isoUpload","kycValidations","legacyMigration","loanProviders","mailLogs","mailLoggables","metadata","moneyThumbBook","notes","oauthTokens","ocrolusBooks","offers","orchestrationLogs","payrollReportStatements","payrolls","phoneValidations","placements","plaid","plaidBankAccounts","plaidBankData","pnl","pnlTransactions","prequalification","productsRequested","receivables","resumeCode","scoreCardGroupResults","scoreCardResults","sentInactivityNotifications","smsLogs","stageLogs","statusLogs","suspiciousActivities","tasks","trackingTokens","underwritingLogs","utmParameters","widgetLogs","widgetSessions","workflowOrchestrationLogs","workflowSnapshot","workflowStatusLogs","properties"],"\u0000*\u0000oldAttributes":[],"enableLoggingModelsEvents":true,"\u0000*\u0000forceDeleting":false,"\u0000*\u0000clearResponseCache":true}}Authorizations
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:
Path Parameters
The ID of the application.
Body
Deprecated, accepted for compatibility and ignored. An application workflow is always sampled at the latest supported schema version.
"3.56.0"
Response
The response is of type string.
"{\"data\":{\"\\u0000*\\u0000connection\":null,\"\\u0000*\\u0000table\":null,\"\\u0000*\\u0000primaryKey\":\"id\",\"\\u0000*\\u0000keyType\":\"int\",\"incrementing\":true,\"\\u0000*\\u0000with\":[],\"\\u0000*\\u0000withCount\":[],\"preventsLazyLoading\":false,\"\\u0000*\\u0000perPage\":15,\"exists\":false,\"wasRecentlyCreated\":false,\"\\u0000*\\u0000escapeWhenCastingToString\":false,\"\\u0000*\\u0000attributes\":{\"user_id\":1667,\"business_id\":906,\"is_business_credit\":false,\"workflow\":1,\"deal_mode\":1},\"\\u0000*\\u0000original\":[],\"\\u0000*\\u0000changes\":[],\"\\u0000*\\u0000previous\":[],\"\\u0000*\\u0000casts\":{\"has_inventory\":\"boolean\",\"has_subscriptions\":\"boolean\",\"has_outstanding_debt\":\"boolean\",\"total_average_debt\":\"float\",\"has_tax_return\":\"boolean\",\"has_payroll_software\":\"boolean\",\"estimated_personal_income\":\"float\",\"total_dept\":\"float\",\"underwriter_review_needed\":\"boolean\",\"is_business_credit\":\"boolean\",\"is_equipment_rental\":\"boolean\",\"is_invoice_factoring\":\"boolean\",\"is_invoice_factoring_codat\":\"boolean\",\"is_no_prequal_docu_plaid\":\"boolean\",\"is_no_prequal_docu\":\"boolean\",\"is_lending_no_prequal_personal_info\":\"boolean\",\"is_data_capture\":\"boolean\",\"is_discovery_complete\":\"boolean\",\"amount_needed\":\"float\",\"offers_declined_at\":\"datetime\",\"finished_at\":\"datetime\",\"underwriter_updated_at\":\"datetime\",\"funding_advisor_updated_at\":\"datetime\",\"analyst_updated_at\":\"datetime\",\"is_client_funded\":\"boolean\",\"has_insurance\":\"boolean\",\"scout_last_import_datetime\":\"datetime\",\"widget_type\":\"App\\\\Models\\\\Enums\\\\WidgetType\",\"widget_destination\":\"array\",\"workflow_segment\":\"App\\\\Services\\\\WorkflowBuilder\\\\Enums\\\\WorkflowSegment\",\"priority\":\"App\\\\Enums\\\\Priority\",\"deleted_at\":\"datetime\"},\"\\u0000*\\u0000classCastCache\":[],\"\\u0000*\\u0000attributeCastCache\":[],\"\\u0000*\\u0000dateFormat\":null,\"\\u0000*\\u0000appends\":[],\"\\u0000*\\u0000dispatchesEvents\":[],\"\\u0000*\\u0000observables\":[],\"\\u0000*\\u0000relations\":[],\"\\u0000*\\u0000touches\":[],\"\\u0000*\\u0000relationAutoloadCallback\":null,\"\\u0000*\\u0000relationAutoloadContext\":null,\"timestamps\":true,\"usesUniqueIds\":false,\"\\u0000*\\u0000hidden\":[],\"\\u0000*\\u0000visible\":[],\"\\u0000*\\u0000fillable\":[\"prequalification_id\",\"business_id\",\"client_id\",\"referrer_absolute_url\",\"has_inventory\",\"inventory_id\",\"has_subscriptions\",\"total_average_debt\",\"has_outstanding_debt\",\"use_of_fund_id\",\"funds_needed_time_id\",\"has_tax_return\",\"has_payroll_software\",\"total_dept\",\"estimated_personal_income\",\"stage\",\"user_id\",\"amount_needed\",\"sales_representative_id\",\"source\",\"analyst_id\",\"underwriter_id\",\"funding_advisor_id\",\"client_analyst_id\",\"client_underwriter_id\",\"client_funding_advisor_id\",\"underwriter_review_needed\",\"branding_id\",\"brand_name_id\",\"email_template_id\",\"is_business_credit\",\"is_equipment_rental\",\"is_invoice_factoring\",\"is_invoice_factoring_codat\",\"is_no_prequal_docu_plaid\",\"is_no_prequal_docu\",\"is_lending_no_prequal_personal_info\",\"is_data_capture\",\"is_discovery_complete\",\"primary_bank_account_id\",\"offers_declined_feedback\",\"offers_declined_at\",\"client_tracking_token\",\"finished_at\",\"funding_advisor_updated_at\",\"underwriter_updated_at\",\"analyst_updated_at\",\"is_client_funded\",\"import_id\",\"has_insurance\",\"deal_mode\",\"workflow\",\"score_card_id\",\"score_card_group_id\",\"reference_application_id\",\"finished_type\",\"widget_type\",\"widget_destination\",\"docusign_placeholder_id\",\"widget_link\",\"requested_workflow_template_id\",\"status\",\"contract_template_id\",\"consent_template_id\",\"workflow_segment\",\"priority\"],\"\\u0000*\\u0000guarded\":[\"*\"],\"\\u0000*\\u0000scoutMetadata\":[],\"\\u0000App\\\\Models\\\\Application\\u0000relatedApplications\":null,\"\\u0000App\\\\Models\\\\Application\\u0000latestExternalServiceLogs\":null,\"\\u0000*\\u0000cascadeRelationships\":[\"accountingData\",\"activityFeedEntries\",\"aiAgentSessions\",\"affiliatedBusinesses\",\"applicationReferrerHost\",\"applicationStips\",\"assets\",\"bankAccountDetails\",\"bankAccounts\",\"billingInformation\",\"bondingAgent\",\"borrowerPlatformUrlVisits\",\"callSessions\",\"commerceData\",\"communicationEmails\",\"companyOfficers\",\"attributeValues\",\"death\",\"debts\",\"debtors\",\"discoveryCallAnswers\",\"documentVerifications\",\"enrichment\",\"enrichmentMetadata\",\"equipmentDetails\",\"equipmentRentalApproval\",\"estimatedSpendAmount\",\"externalServiceLogs\",\"fileables\",\"fundingAdvisorLogs\",\"guarantor\",\"insurance\",\"isoUpload\",\"kycValidations\",\"legacyMigration\",\"loanProviders\",\"mailLogs\",\"mailLoggables\",\"metadata\",\"moneyThumbBook\",\"notes\",\"oauthTokens\",\"ocrolusBooks\",\"offers\",\"orchestrationLogs\",\"payrollReportStatements\",\"payrolls\",\"phoneValidations\",\"placements\",\"plaid\",\"plaidBankAccounts\",\"plaidBankData\",\"pnl\",\"pnlTransactions\",\"prequalification\",\"productsRequested\",\"receivables\",\"resumeCode\",\"scoreCardGroupResults\",\"scoreCardResults\",\"sentInactivityNotifications\",\"smsLogs\",\"stageLogs\",\"statusLogs\",\"suspiciousActivities\",\"tasks\",\"trackingTokens\",\"underwritingLogs\",\"utmParameters\",\"widgetLogs\",\"widgetSessions\",\"workflowOrchestrationLogs\",\"workflowSnapshot\",\"workflowStatusLogs\",\"properties\"],\"\\u0000*\\u0000oldAttributes\":[],\"enableLoggingModelsEvents\":true,\"\\u0000*\\u0000forceDeleting\":false,\"\\u0000*\\u0000clearResponseCache\":true}}"
Was this page helpful?