Skip to main content
POST
Create a Funded Offer

Authorizations

Authorization
string
header
required


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.

Path Parameters

application_id
string
required

The ID of the application.

Body

application/json
product_id
string

The ID of the product for the offer. Required when offer_template_id is not provided. This field is required when offer_template_id is not present. Must match an existing stored value.

Example:

1

stips
object[]

The stips to attach to the offer. Defaults to the stips defined on the offer template.

Example:

null

client_url
string | null

A URL the borrower can visit to view the offer. Must be a valid URL. Must not be greater than 2083 characters.

Example:

"https://example.com/offers/123"

offer_template_id
string

The ID of the offer template to build the offer from. Required when product_id is not provided. This field is required when product_id is not present. Must match an existing stored value.

Example:

1

is_shared
boolean

Whether the offer is shared with the borrower.

Example:

false

Response

200 - application/json
data
object