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>
object
productId
string format: uuid
partner
object
headquarters
string
name
string
description
string
areasServed
string
amountFinancedToDate
integer format: int64
smallBusinessesServed
integer format: int64
establishedYear
integer format: int32
languages
string
website
string
details
object
name
string
productImage
string
kind
string
interestRateRange
object
min
number format: double
max
number format: double
unit
string
termsRange
object
min
number format: double
max
number format: double
unit
string
timeToFundRange
object
min
number format: double
max
number format: double
unit
string
collateralType
string
loanType
string
applicationFee
object
min
number format: double
max
number format: double
unit
string
originationFee
object
min
number format: double
max
number format: double
unit
string
paymentFrequency
string
maxMoneyAmount
The maximum amount that can be received from this product
number format: double
purpose
Grant only: The purpose of the grant
string
awardAmount
object
min
number format: double
max
number format: double
unit
string
cost
object
min
number format: double
max
number format: double
unit
string
location
string
info
Business Service Specific: Other information about the business service provided
string
offeredServices
Business Service Specific: The business services offered
Array<string>
otherResources
required
Additional resources that may assist the user
Array<object>
object
name
The name of the additional resource
string
description
string
url
string
imageUrl
string
deviceMetadata
object
isoLanguageName
string
riskScore
number format: float
deviceId
string
202
Accepted
object
type
string
title
string
status
integer format: int32
detail
string
instance
string
key
additional properties
404
Not Found
object
type
string
title
string
status
integer format: int32
detail
string
instance
string
key
additional properties
429
Too Many Requests
object
type
string
title
string
status
integer format: int32
detail
string
instance
string
key
additional properties