Skip to content

Get product matches for a submission

GET
/api/{referralpartner}/form/products

Retrieve product matches for a submission. Matches are sorted based on the user’s email address.

Authorizations

Parameters

Path Parameters

referralpartner
required
string

Query Parameters

submissionId
required
string format: uuid

Responses

200

OK

object
id
required

The id of the submission

string format: uuid
products
required

Products that match the submission

Array<object>
nullable
object
productId
string format: uuid
partner
object
headquarters
string
nullable
name
string
nullable
description
string
nullable
areasServed
string
nullable
amountFinancedToDate
integer format: int64
nullable
smallBusinessesServed
integer format: int64
nullable
establishedYear
integer format: int32
nullable
languages
string
nullable
website
string
nullable
details
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
otherResources
required

Additional resources that may assist the user

Array<object>
nullable
object
name

The name of the additional resource

string
nullable
description
string
nullable
url
string
nullable
imageUrl
string
nullable
deviceMetadata
object
isoLanguageName
string
nullable
riskScore
number format: float
nullable
deviceId
string
nullable

202

Accepted

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

404

Not Found

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

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