Get Form

200

Form found.

Response body

object

formTemplateId

string

required

The form template that will be used to populate the styling and other paramaters. Styling and data may be overwritten with individual API fields.

merchantId

string

required

The Preczn merchant ID of the merchant that should be used. Will prepopulate existing data and updates will be saved to this merchant record.

connectionId

string

required

This specifies which connection requirements should be used and also determines which terms of service to populate. Either enumerations or exact connection IDs are supported.

StripeConnect Payrix Greensky Jaris Rainforest

name

string

Used to populate the title that is displayed in browsers (notably is visible on browser tabs).

returnUrl

string

URL the merchant will be redirected to after completion of the form.

autoTransmitMerchantData

boolean

Determines if merchant data is automatically sent to connection upon completion of form. For KYC form types, a value of yes will attempt to onboard merchant. For RFI form types, will automatically patch the new data to the connection. If not specified in the request or form template, the default value will be false.

expirationUrl

string

URL the merchant will be redirected to in the event that the form has expired.

tosUrl

string

(Deprecated) URL with your brand's terms of service.

expirationInHours

number

1 to 2160

The amount of hours until the form expires. If not specified in the request or form template, the default value will be 24.

displayTos

boolean

Whether or not the T&Cs for the connection will display in the form. Only applicable for KYC forms.

displayNewUserLogin

boolean

This field is used to the display of the Account Login user creation screen, specifically designed for KYC forms associated with certain connections. The data collected from this process is utilized to create the user's account login for the merchant portal related to your connections.

heading

object

Variables used to populate the header of the form webpage

title

string

Title text that is displayed in the header.

titleColor

string

Hex color that will be used for header text.

accentColor

string

Hex color that will be used for the section progress icons.

button

object

Variables that determine the styling of the buttons in form

textColor

string

Hex color that will be used for button text font color.

accentColor

string

Hex color that will be used for button background color.

support

object

Variables that are used to populate the support modal. If not specified in the request or form template, the support button will not display.

url

string

Website merchants may visit for support or FAQs. If not specified in the request or form template, the website button will not display.

string

Email that merchant can use to reach support. Opens email client. If not specified in the request or form template, the email button will not display.

phone

string

Phone Number that merchants may call to contact support. Must be 11 digits with no formatting. If not specified in the request or form template, the phone number will not display.

text

string

Text that will display under phone number. If not specified in the request or form template, the text will not display.

mccCodes

string

Comma separated list of Merchant Category Codes to be included as options in the MCC dropdown of the form. Can be used to override your platforms default MCC codes. If not specified in the request or form template, your platforms default MCC codes will be used.

type

string

The type of form that will be generated. If not specified in the request or form template, the default value will be KYC.

KYC RFI

customFormFields

object

required

businessInfo

object

owners

object

banking

object

attachments

object

200Form found.