Create Application

post

https://staging-apptracker.herokuapp.com/api/v1/applications

This endpoint will need the helper api Get Services to select which service type is being done on the job.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

dealer_id

string

required

Body Params

serviceType

string

required

Use the /service endpoint to get the list of services, and pass the "key" field as the serviceType when creating an application.

subService

string

Optional, more specific, service type

installationAddress

object

required

Where the work that's being financed is being done

price

float

required

The amount being financed. Should be in USD, such as "3480.99". This must be greater than the min price of the Service, and less than the max price.

applicant

object

required

Details about the primary applicant for this project

secondaryApplicant

object

Optional secondary Applicant. We

invoiceID

string

Optional ID from your system. This ID will be sent with the application update webhook, which you can then use it to look up in your system.

returnURL

string

If you pass this, we will redirect the applicant to this URL after they submit their application on our platform.

redirectURL

string

Optional URL that we will use on emails and sms copy to the contractor. You can use either {id} or {invoiceID} and we will replace it with those fields from the application.

returnWhen

string

enum

If set to always, we will return the applicant as soon as they submit the app. This will allow you to have the applicant complete the process on your system. If you don't want to implement this part, you can use "decline-only" and we will only redirect if they are declined.

Allowed:

user

object

User responsible of the application processing

partnerBrand

string

A partner brand that can be displayed on the white labeled page

partnerFee

string

A partner fee the contractor is charged when the loan is booked

kycID

string

We need your KYC(know your customer) ID to comply with regulatory requirements, ensure accurate records for audits, and have a reliable reference for addressing any account-related questions, while keeping your information secure and confidential.

prequalOffered

string

Pass the value obtained from the fetch prequalification endpoint that was selected by the homeowner.

Responses

200200

400400