Submit A New Application Via The API
Users can use Create Application Using Workflow Builder (POST /api/applications/workflow) to submit a new application, which requires three inputs:
- A Bearer token or Integration Token for authentication
- Deal payload: This contains the application information
- Workflow Template ID: A Workflow Template ID (Lendflow global template or custom template ) is used to match the submitted application to the Workflow Template of your choice
1. Choose an Authentication Token
Lendflow supports either authentication option:- Bearer Token endpoint: Call Get Bearer Token using the email and password registered with Lendflow.
- Integration Token: Create a scoped token from Profile → Integration Tokens in the Lendflow Dashboard. See Integration Tokens for creation, permissions, storage, expiration, and revocation.
Authorization: Bearer <token> request header. Treat both token types like passwords and store them securely.
2. Creating a Sample Deal Payload
The payload is where your application information goes. The example below includes the minimal data required to create an application and can be used as a starter. Some fields accept only specific IDs or values. Before building your payload, review Lendflow Validations For Data Collection for available field input options and accepted values. Before submitting:- Replace the sample values with your actual application data
- Set
workflow_template_idto a Lendflow global template ID or a custom template ID.
JSON
3. Workflow Template ID
The Workflow Builder allows users to customize their workflow templates when submitting deals via the API. The template ID matches the application to the selected template. Users can specify a global or client workflow template. List the templates available to your account with List Workflow Templates (GET /api/workflow_templates).
Global Workflow Template IDs
To use a Lendflow global template, setworkflow_template_id to that template’s ID from List Workflow Templates. Your customer success manager can also provide the global template IDs for your account.
Client Workflow Template ID
Users are also able to use their own Workflow Template ID and input it in theworkflow_template_id field.
Creating the Application via API
Once the user has their sample payload and Workflow Template ID for theworkflow_template_id field, they can send the information to Create Application Using Workflow Builder (POST /api/applications/workflow). All other fields are optional.
When using a non-global WFB template, required fields can be customized in the template. The ‘with_validation’ field allows the user to choose whether to validate the required fields set in the template.
- If ‘with_validation’ is set to ‘true’, the endpoint will return any required fields which have no values. All required fields must have values filled out before the application submission is successful.
- If ‘with_validation’ is set to ‘false’, the application submission will be successful even if required fields have no value set. However, the user will not be able to move the deal to the next stage until all the required fields have a value filled out.
Track an application via Webhooks
Lendflow has different webhooks for users to track their applications and progress through the different stages. Users can set up notifications for Global Workflows or Custom Workflows. Webhook signature verification is optional but recommended. If your organization wants to verify webhook signatures, request its webhook secret from Lendflow’s Customer Success team and follow Verifying Webhook Authenticity. Treat the secret like a password.Update an Application
After creating the application, follow Manage an Application via the API for the full post-creation flow. Use Update Application Workflow Data (PUT /api/applications/{application_id}/workflow) when application fields change.
FAQ
What do I need to submit an application?
What do I need to submit an application?
You need three inputs: a Bearer token or Integration Token, a deal payload with the application information, and a
workflow_template_id for a Lendflow global template or a custom template.What does with_validation do?
What does with_validation do?
On a non-global workflow template, required fields come from the template. If
with_validation is true, the endpoint returns any required fields that have no value, and submission fails until those fields are filled. If with_validation is false, submission succeeds even when required fields are empty, and you cannot move the deal to the next stage until those fields have values.How do I choose a workflow template ID?
How do I choose a workflow template ID?
Set
workflow_template_id to a Lendflow global template ID or to your own custom workflow template ID. List available templates with List Workflow Templates.How do I update an application after I submit it?
How do I update an application after I submit it?
Follow Manage an Application via the API for application updates, document uploads, stage transitions, underwriting, offers, closing, and funding.
Next steps
Manage an Application via the API
Continue from application creation through underwriting, offers, closing, and funding.
Lendflow Validations For Data Collection
Look up field IDs and allowed values for the deal payload.
Verifying Webhook Authenticity
Confirm that webhook requests were sent by Lendflow.