Get the questionnaire

Authorizations

Bearer
api-key

Path Parameters

referralpartner

required

String

string

Query Parameters

slug

String

string

200

OK

OutputForm

object

agentImageUrl

String

The image of the ‘agent’ guide for the form

string

nullable

pages

List`1

The list of pages in the form

Array<object>

nullable

OutputFormPage

object

encouragement

String

A brief encouragement to the user

string

nullable

title

String

The title of the questionnaire page

string

nullable

hint

String

A brief hint to the user

string

nullable

layout

OutputFormPageLayout

object

columns

Nullable`1

The number of columns to use to layout the questions

integer format: int32

nullable

columnTemplate

String

The column template to use to layout the questions, for HTML grids

string

nullable

questions

required

List`1

The question(s) asked on this page

Array<object>

OutputFormQuestion

object

kind

QuestionType

string

Allowed values: FirstName LastName Email Phone CreditScore OwnershipDemographics BusinessName BusinessType BusinessIndustry YearsInBusiness BusinessNumEmployees BusinessAddress PriorBankruptcy HasBusinessPlan RevenueLastYear RevenueProjected NetProfit RequestedAmount UseOfProceeds FinanceNeededBy PreferredContactMethod PreferredContactTime Collateral BusinessService YesNo CustomText CustomAddress CustomNumber CustomMultiChoice CustomSingleChoice

id

String

The unique id of the question to be used in the answers object

string

col

Nullable`1

The HTML column to put the question into

integer format: int32

nullable

colSpan

Nullable`1

How many columns the question should span

integer format: int32

nullable

label

String

The user-friendly label for the question

string

nullable

placeholder

String

Default placeholder text for the question, if applicable

string

nullable

isRequired

Nullable`1

Whether the question is required

boolean

nullable

defaultValue

Nullable`1

The default value given to the backend if no answer is provided

nullable

isLabelAlwaysOn

Nullable`1

Whether to show the label continuously

boolean

nullable

minValue

Nullable`1

The minimum value allowed for the question, if applicable

integer format: int32

nullable

maxValue

Nullable`1

The maximum value allowed for the question, if applicable

integer format: int32

nullable

prefix

String

The prefix for the question, for example a currency symbol

string

nullable

postfix

String

The postfix for the question, for example a percentage sign

string

nullable

isDollar

Nullable`1

Whether or not the numeric value represents a dollar amount

boolean

nullable

isDropdown

Nullable`1

Whether or not the options should be displayed as a dropdown or a radio button list

boolean

nullable

minLength

Nullable`1

The minimum number of characters allowed

integer format: int32

nullable

maxLength

Nullable`1

The maximum allowable length for text input, if applicable

integer format: int32

nullable

minDate

Nullable`1

The minimum date allowed for the question, if applicable

string format: date

nullable

maxDate

Nullable`1

The maximum date allowed for the question, if applicable

string format: date

nullable

options

List`1

Dropdown, single-select or multi-select options

Array<object>

nullable

OutputFormQuestionOption

object

id

required

String

The code-friendly ID of the option

string

label

required

String

The human-readable label for the option

string

none

String

The ‘None’ option, if applicable, if the user explicitly wants to unset all other options

string

nullable

pattern

String

Specifies a regular expression pattern that the answer must match

string

nullable

format

String

The format to take the number in (i.e. ##-#######)

string

nullable

mask

String

Specifies a regular expression pattern that the answer must match

string

nullable

requireFullNAICS

Nullable`1

Whether the business industry question requires a full NAICS code

boolean

nullable

inputType

InputType

string

Allowed values: Text Tel Email Date DateTime

autocomplete

String

Value of the autocomplete attribute for the input

string

nullable

isMultiline

Nullable`1

Specifies if the input is a multiline textarea

boolean

nullable

followUp

Array<object> recursive

condition

OuptutFormPageCondition

object

question

required

String

The question to check

string

operator

FormPageConditionOperator

string

Allowed values: Equals NotEquals GreaterThan LessThan In

value

JsonElement

The value to compare the question’s answer to

results

OutputFormResults

object

showNextSteps

Nullable`1

Hide or show a instructional page before showing matches

boolean

nullable

nextStepsTitle

String

string

nullable

nextStepsNoMatchTitle

String

string

nullable

nextStepsNoMoneyTitle

String

string

nullable

nextStepsBadge

String

string

nullable

nextStepsSteps

OutputNextStep[]

Array<object>

nullable

OutputNextStep

object

title

String

string

nullable

description

String

string

nullable

nextStepsNoMatchSteps

OutputNextStep[]

Array<object>

nullable

OutputNextStep

object

title

String

string

nullable

description

String

string

nullable

nextStepsNoMoneySteps

OutputNextStep[]

Array<object>

nullable

OutputNextStep

object

title

String

string

nullable

description

String

string

nullable

nextStepsBody

String

string

nullable

nextStepsNoMatchBody

String

string

nullable

nextStepsNoMoneyBody

String

string

nullable

nextStepsAction

String

string

nullable

nextStepsNoMatchAction

String

string

nullable

nextStepsNoMoneyAction

String

string

nullable

loansDescription

String

string

nullable

grantsDescription

String

string

nullable

businessServicesDescription

String

string

nullable

additionalResourcesDescription

String

string

nullable

showTabs

Nullable`1

boolean

nullable

showAPRColumn

Nullable`1

boolean

nullable

showLoanTermColumn

Nullable`1

boolean

nullable

showCollateralColumn

Nullable`1

boolean

nullable

showLoanTypeColumn

Nullable`1

boolean

nullable

showApplicationFeeColumn

Nullable`1

boolean

nullable

showOriginationFeeColumn

Nullable`1

boolean

nullable

showPaymentFrequencyColumn

Nullable`1

boolean

nullable

showTimeToFundColumn

Nullable`1

boolean

nullable

showPurposeColumn

Nullable`1

boolean

nullable

showAwardAmountColumn

Nullable`1

boolean

nullable

showOfferedServicesColumn

Nullable`1

boolean

nullable

showCostColumn

Nullable`1

boolean

nullable

showLocationColumn

Nullable`1

boolean

nullable

showOfferDetails

Nullable`1

boolean

nullable

showAboutServicePartner

Nullable`1

boolean

nullable

showAdditionalResources

Nullable`1

boolean

nullable

maxLoans

Nullable`1

The maximum number of loans the applicant can select

integer format: int32

nullable

maxBusinessServices

Nullable`1

The maximum number of business services the applicant can select

integer format: int32

nullable

maxGrants

Nullable`1

The maximum number of grants the applicant can select

integer format: int32

nullable

showReview

Nullable`1

Hide or or show a final confirmation page before submitting leads

boolean

nullable

confirmation

OutputFormConfirmation

object

title

String

string

nullable

subtitle

String

string

nullable

nextSteps

OutputNextStep[]

Array<object>

nullable

OutputNextStep

object

title

String

string

nullable

description

String

string

nullable

showSentiment

Nullable`1

boolean

nullable

matchesTypes

List`1

The types of products that can be matched with this form

Array<string>

nullable

Allowed values: Loan Grant BusinessService

shared

Dictionary`2

Shared setting strings

object

key

additional properties

String

string

nullable

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

Get the questionnaire

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

404