> ## Documentation Index > Fetch the complete documentation index at: https://docs.lendflow.com/llms.txt > Use this file to discover all available pages before exploring further. # Sample Payload - Workflow > Show a sample payload that the user can use as a template/guide when submitting data to update an application. ## OpenAPI ````yaml /openapi.yaml get /api/applications/{application_id}/workflow/sample openapi: 3.0.3 info: title: Lendflow API docs description: '' version: 1.0.0 servers: - url: https://api.lendflow.com security: - default: [] tags: - name: Authentication description: >- 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.
- name: Access Tokens description: |- Create and manage the personal access tokens used to authenticate API requests. - name: Workflow Management description: |- Create applications and manage them through every stage of their workflow, from intake through decision. - name: Documents description: |- Upload, retrieve, and manage the files attached to an application. - name: Placements description: |- Submit applications to lenders and manage each placement through its lifecycle. - name: Offers description: |- Create and manage offers on an application, from initial terms through funding. - name: Smartviews description: |- Save and manage reusable application filters that organize your pipeline. - name: Workflow Templates description: |- Browse the workflow templates available for creating applications. - name: Consent Templates description: |- Manage the consent documents presented to applicants for signature. - name: Offer Templates description: |- Manage the templates that define the structure and fields of your offers. - name: Data Orchestration description: |- Run data orchestration templates against applications and review their execution logs. - name: Attributes description: |- Define computed attributes and evaluate them against your applications. - name: Scorecards description: |- Run scorecards and scorecard groups against applications and retrieve their results. - name: Entity Profiles description: |- Manage the reusable business and individual profiles shared across applications. - name: Organization description: |- Manage the users in your organization. - name: Metadata description: |- Attach custom key-value data to your applications and files. paths: /api/applications/{application_id}/workflow/sample: parameters: - in: path name: application_id description: The ID of the application. example: architecto required: true schema: type: string get: tags: - Workflow Management summary: Sample Payload - Workflow description: |- Show a sample payload that the user can use as a template/guide when submitting data to update an application. parameters: [] requestBody: required: false content: application/json: schema: type: object properties: schema_version: type: string description: >- Deprecated, accepted for compatibility and ignored. An application workflow is always sampled at the latest supported schema version. example: 3.56.0 responses: '200': description: '' content: text/plain: schema: type: string example: >- {"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}} components: securitySchemes: default: type: http scheme: bearer description: >-
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.
````