Skip to content

Submit form to one of our partners

POST
/api/{referralpartner}/form/apply

Submit a form to one of our partners. The submission is validated against the form’s configuration and the referrer’s settings.

Authorizations

Parameters

Path Parameters

referralpartner
required
string

Query Parameters

skipFraudCheck

Skip fraud check if this user is already authenticated

boolean

Skip fraud check if this user is already authenticated

Request Body required

object
submissionId
required

The submission id

string format: uuid
productId
required

The product id to match with

string format: uuid

Responses

201

Created

object
leadId
string format: uuid
nullable
partnerName
required

The partner matched from the submission

string
website

The partner’s website

string
nullable
contactName

The partner contact’s name

string
nullable
contactTitle

The partner contact’s title

string
nullable
contactEmail

The partner contact’s email

string
nullable
contactPhone

The partner contact’s phone

string
nullable
contactAddress

The partner contact’s phone extension

string
nullable
contactAboutMe

The partner contact’s about me

string
nullable
productId

The product matched

string format: uuid
details
required
object
name
string
nullable
productImage
string
nullable
kind
string
Allowed values: Loan Grant BusinessService
interestRateRange
object
min
number format: double
max
number format: double
nullable
unit
string
nullable
termsRange
object
min
number format: double
max
number format: double
nullable
unit
string
nullable
timeToFundRange
object
min
number format: double
max
number format: double
nullable
unit
string
nullable
collateralType
string
Allowed values: Secured Unsecured
loanType
string
Allowed values: TermLoan LineOfCredit MerchantCashAdvance MicroLoan
applicationFee
object
min
number format: double
max
number format: double
nullable
unit
string
nullable
originationFee
object
min
number format: double
max
number format: double
nullable
unit
string
nullable
paymentFrequency
string
Allowed values: Daily Weekly BiWeekly Monthly
maxMoneyAmount

The maximum amount that can be received from this product

number format: double
nullable
purpose

Grant only: The purpose of the grant

string
nullable
awardAmount
object
min
number format: double
max
number format: double
nullable
unit
string
nullable
cost
object
min
number format: double
max
number format: double
nullable
unit
string
nullable
location
string
Allowed values: InPerson Virtual Both
info

Business Service Specific: Other information about the business service provided

string
nullable
offeredServices

Business Service Specific: The business services offered

Array<string>
nullable
formHandoff
object
endpoint
required
string

404

Not Found

string
Allowed values: Success AlreadyMatched ProductNotFound FormNotFound SubmissionNotFound AddressNotFound LeadNotCreated

409

Conflict

string
Allowed values: Success AlreadyMatched ProductNotFound FormNotFound SubmissionNotFound AddressNotFound LeadNotCreated

429

Too Many Requests

object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties