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.

referralpartner
required
String
string
skipFraudCheck
Nullable`1

Skip fraud check if this user is already authenticated

boolean

Skip fraud check if this user is already authenticated

InputMatchProduct
object
submissionId
required
Guid

The submission id

string format: uuid
productId
required
Guid

The product id to match with

string format: uuid

Created

OutputMatchResult
object
leadId
Nullable`1
string format: uuid
nullable
partnerName
required
String

The partner matched from the submission

string
website
String

The partner’s website

string
nullable
contactName
String

The partner contact’s name

string
nullable
contactTitle
String

The partner contact’s title

string
nullable
contactEmail
String

The partner contact’s email

string
nullable
contactPhone
String

The partner contact’s phone

string
nullable
contactAddress
String

The partner contact’s phone extension

string
nullable
contactAboutMe
String

The partner contact’s about me

string
nullable
productId
Guid

The product matched

string format: uuid
details
required
OutputProductDetails
object
name
String
string
nullable
productImage
String
string
nullable
kind
ProductType
string
Allowed values: Loan Grant BusinessService
interestRateRange
OutputNumberRange
object
min
Decimal
number format: double
max
Nullable`1
number format: double
nullable
unit
String
string
nullable
termsRange
OutputNumberRange
object
min
Decimal
number format: double
max
Nullable`1
number format: double
nullable
unit
String
string
nullable
timeToFundRange
OutputNumberRange
object
min
Decimal
number format: double
max
Nullable`1
number format: double
nullable
unit
String
string
nullable
collateralType
CollateralType
string
Allowed values: Secured Unsecured
loanType
LoanType
string
Allowed values: TermLoan LineOfCredit MerchantCashAdvance MicroLoan
applicationFee
OutputNumberRange
object
min
Decimal
number format: double
max
Nullable`1
number format: double
nullable
unit
String
string
nullable
originationFee
OutputNumberRange
object
min
Decimal
number format: double
max
Nullable`1
number format: double
nullable
unit
String
string
nullable
paymentFrequency
PaymentFrequency
string
Allowed values: Daily Weekly BiWeekly Monthly
maxMoneyAmount
Nullable`1

The maximum amount that can be received from this product

number format: double
nullable
purpose
String

Grant only: The purpose of the grant

string
nullable
awardAmount
OutputNumberRange
object
min
Decimal
number format: double
max
Nullable`1
number format: double
nullable
unit
String
string
nullable
cost
OutputNumberRange
object
min
Decimal
number format: double
max
Nullable`1
number format: double
nullable
unit
String
string
nullable
location
BusinessServiceLocation
string
Allowed values: InPerson Virtual Both
info
String

Business Service Specific: Other information about the business service provided

string
nullable
offeredServices
List`1

Business Service Specific: The business services offered

Array<string>
nullable
formHandoff
OutputFormHandoff
object
endpoint
required
String
string

Not Found

ApplicationResultType
string
Allowed values: Success AlreadyMatched ProductNotFound FormNotFound SubmissionNotFound AddressNotFound LeadNotCreated ExceededMaxProductType

Conflict

ApplicationResultType
string
Allowed values: Success AlreadyMatched ProductNotFound FormNotFound SubmissionNotFound AddressNotFound LeadNotCreated ExceededMaxProductType

Too Many Requests

ProblemDetails
object
type
String
string
nullable
title
String
string
nullable
status
Nullable`1
integer format: int32
nullable
detail
String
string
nullable
instance
String
string
nullable
key
additional properties
Object