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

• Bearer
• api-key

Parameters

Path Parameters

referralpartner

required

String

string

Query Parameters

submissionId

required

Guid

string format: uuid

Responses

200

OK

OutputMatches

object

id

required

Guid

The id of the submission

string format: uuid

products

required

List`1

Products that match the submission

Array<object>

nullable

OutputProduct

object

productId

Guid

string format: uuid

partner

OutputPartnerMetadata

object

headquarters

String

string

nullable

name

String

string

nullable

description

String

string

nullable

areasServed

String

string

nullable

amountFinancedToDate

Nullable`1

integer format: int64

nullable

smallBusinessesServed

Nullable`1

integer format: int64

nullable

establishedYear

Nullable`1

integer format: int32

nullable

languages

String

string

nullable

website

String

string

nullable

details

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

otherResources

required

List`1

Additional resources that may assist the user

Array<object>

nullable

OutputAdditionalResource

object

name

String

The name of the additional resource

string

nullable

description

String

string

nullable

url

String

string

nullable

imageUrl

String

string

nullable

deviceMetadata

OutputDeviceMetadata

object

isoLanguageName

String

string

nullable

riskScore

Nullable`1

number format: float

nullable

deviceId

String

string

nullable

202

Accepted

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

404

Not Found

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

429

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