Update Form Template

patch

https://api.preczn.com/v1/formTemplates/{id}

Path Params

string

required

Body Params

Partial update. Send only the multipart parts you wish to change. All values are strings on the wire; the server coerces booleans/numbers/arrays as documented per field.

platformId

string

Id for the Preczn Platform.

isTestMode

string

enum

String-coerced boolean indicating if the form-template is for Test Mode. Send "true" or "false".

Allowed:

autoTransmitMerchantData

string

enum

String-coerced boolean. If "true", merchant data is automatically sent to the connection upon completion of the form. Default false.

Allowed:

name

string

The form template name. Example: "Onboarding Form".

domain

string

Domain configured for your platform. Example: "https://boarding.democompany.com".

returnUrl

string

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

expirationUrl

string

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

tosUrl

string

URL with your brand's terms of service.

expirationInHours

string

^[0-9]+$

String-coerced number. Hours until the form expires. Default 24, min 1, max 2160. Send as numeric string (e.g. "24").

displayTos

string

enum

String-coerced boolean. Whether the T&Cs for the connection will display. Send "true" or "false".

Allowed:

displayPciSaq

string

enum

String-coerced boolean. Whether the PCI SAQ compliance step displays. Send "true" or "false".

Allowed:

displayNewUserLogin

string

enum

String-coerced boolean. Controls the Account Login user creation screen. Send "true" or "false".

Allowed:

mccCodes

string

Comma-separated list of Merchant Category Codes to include in the MCC dropdown. Overrides platform defaults.

type

string

enum

The type of form that will be generated. Default KYC.

Allowed:

headingTitle

string

Title text displayed in the header.

headingTitleColor

string

Hex color for header text. Default #000000.

headingAccentColor

string

Hex color for section progress icons. Default #4013BE.

buttonTextColor

string

Hex color for button text. Default #FFFFFF.

buttonAccentColor

string

Hex color for button background. Default #808080.

supportUrl

string

Website merchants may visit for support or FAQs.

supportEmail

string

Support email address.

supportPhone

string

Support phone number (11 digits, no formatting).

supportText

string

Text displayed under the support phone number.

logo

file

Custom logo image displayed in the form header. Supported formats: .jpg, .jpeg, .png. Maximum dimensions: 250x100 pixels. Maximum size: 2 MB. Sent as a binary multipart part.

favicon

file

Custom favicon image for this form template. Supported formats: .ico, .png, .svg. Maximum dimensions: 64x64 pixels. Maximum size: 512 KB. Sent as a binary multipart part.

businessInfo.fields.legalName.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.legalName.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.legalName.fieldConstraints.minLength

string

^[0-9]+$

String-coerced number. Send a numeric string (e.g. "400"). Server coerces via Number().

businessInfo.fields.legalName.fieldConstraints.maxLength

string

^[0-9]+$

String-coerced number. Send a numeric string (e.g. "400"). Server coerces via Number().

businessInfo.fields.legalName.fieldConstraints.allowAlpha

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.legalName.fieldConstraints.allowNumeric

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.legalName.fieldConstraints.allowWhitespace

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.legalName.fieldConstraints.allowedSpecialCharacters

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.website.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.website.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.website.fieldConstraints.minLength

string

^[0-9]+$

String-coerced number. Send a numeric string (e.g. "400"). Server coerces via Number().

businessInfo.fields.website.fieldConstraints.maxLength

string

^[0-9]+$

String-coerced number. Send a numeric string (e.g. "400"). Server coerces via Number().

businessInfo.fields.website.fieldConstraints.allowAlpha

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.website.fieldConstraints.allowNumeric

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.website.fieldConstraints.allowWhitespace

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.website.fieldConstraints.allowedSpecialCharacters

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.address.fields.country.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.address.fields.country.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.address.fields.postal.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.address.fields.postal.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.address.fields.region.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.address.fields.region.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.address.fields.city.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.address.fields.city.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.address.fields.address.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.address.fields.address.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.address.fields.address2.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.address.fields.address2.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.phone.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.phone.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.tin.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.tin.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.tin.fieldConstraints.minLength

string

^[0-9]+$

String-coerced number. Send a numeric string (e.g. "400"). Server coerces via Number().

businessInfo.fields.tin.fieldConstraints.maxLength

string

^[0-9]+$

String-coerced number. Send a numeric string (e.g. "400"). Server coerces via Number().

businessInfo.fields.tinType.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.tinType.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.tinType.enum

string

enum

Stringified JSON-style array literal of allowed vocabulary tokens (e.g. "['val1','val2']"). Server parses via stringified-array coercion. The enum property on this schema lists the allowed individual tokens — pick any subset.

Allowed:

businessInfo.fields.businessType.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.businessType.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.businessType.enum

string

enum

Allowed:

businessInfo.fields.email.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.email.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.annualFinanceVolume.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.annualFinanceVolume.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.mailingAddress.fields.country.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.mailingAddress.fields.country.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.mailingAddress.fields.postal.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.mailingAddress.fields.postal.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.mailingAddress.fields.region.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.mailingAddress.fields.region.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.mailingAddress.fields.city.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.mailingAddress.fields.city.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.mailingAddress.fields.address.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.mailingAddress.fields.address.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.mailingAddress.fields.address2.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.mailingAddress.fields.address2.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.publicCompany.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.publicCompany.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.stateIncorporated.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.stateIncorporated.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.countryIncorporated.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.countryIncorporated.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.dateEstablished.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.dateEstablished.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.customerServicePhone.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.customerServicePhone.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.productServiceDescription.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.productServiceDescription.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.productServiceDescription.fieldConstraints.minLength

string

^[0-9]+$

String-coerced number. Send a numeric string (e.g. "400"). Server coerces via Number().

businessInfo.fields.productServiceDescription.fieldConstraints.maxLength

string

^[0-9]+$

String-coerced number. Send a numeric string (e.g. "400"). Server coerces via Number().

businessInfo.fields.productServiceDescription.fieldConstraints.allowAlpha

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.productServiceDescription.fieldConstraints.allowNumeric

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.productServiceDescription.fieldConstraints.allowWhitespace

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.productServiceDescription.fieldConstraints.allowedSpecialCharacters

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.mcc.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.mcc.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.annualSaleVolume.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.annualSaleVolume.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.averageTicket.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.averageTicket.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.highTicket.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.highTicket.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.billingContact.fields.country.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.billingContact.fields.country.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.billingContact.fields.postal.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.billingContact.fields.postal.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.billingContact.fields.region.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.billingContact.fields.region.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.billingContact.fields.city.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.billingContact.fields.city.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.billingContact.fields.address.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.billingContact.fields.address.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.billingContact.fields.address2.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.billingContact.fields.address2.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.billingContact.fields.firstName.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.billingContact.fields.firstName.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.billingContact.fields.lastName.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.billingContact.fields.lastName.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.billingContact.fields.phone.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.billingContact.fields.phone.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.billingContact.fields.email.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.billingContact.fields.email.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.name.fieldConstraints.minLength

string

^[0-9]+$

String-coerced number. Send a numeric string (e.g. "400"). Server coerces via Number().

businessInfo.fields.name.fieldConstraints.maxLength

string

^[0-9]+$

String-coerced number. Send a numeric string (e.g. "400"). Server coerces via Number().

businessInfo.fields.name.fieldConstraints.allowAlpha

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.name.fieldConstraints.allowNumeric

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.name.fieldConstraints.allowWhitespace

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.name.fieldConstraints.allowedSpecialCharacters

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.name.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.name.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.fields.shipToDays.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.fields.shipToDays.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.attachments.determinationLetter501c3.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.attachments.determinationLetter501c3.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

businessInfo.attachments.form990.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

businessInfo.attachments.form990.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.title.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.title.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.type.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.type.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.type.enum

string

enum

Allowed:

owners.fields.firstName.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.firstName.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.middleName.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.middleName.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.lastName.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.lastName.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.address.fields.country.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.address.fields.country.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.address.fields.postal.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.address.fields.postal.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.address.fields.region.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.address.fields.region.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.address.fields.city.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.address.fields.city.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.address.fields.address.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.address.fields.address.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.address.fields.address2.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.address.fields.address2.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.businessTitle.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.businessTitle.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.businessTitle.fieldConstraints.minLength

string

^[0-9]+$

String-coerced number. Send a numeric string (e.g. "400"). Server coerces via Number().

owners.fields.businessTitle.fieldConstraints.maxLength

string

^[0-9]+$

String-coerced number. Send a numeric string (e.g. "400"). Server coerces via Number().

owners.fields.businessTitle.fieldConstraints.allowAlpha

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.businessTitle.fieldConstraints.allowNumeric

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.businessTitle.fieldConstraints.allowWhitespace

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.businessTitle.fieldConstraints.allowedSpecialCharacters

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.citizenshipCountry.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.citizenshipCountry.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.email.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.email.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.phone.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.phone.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.dob.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.dob.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.ssn.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.ssn.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.ssnLast4.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.ssnLast4.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.ownershipPercent.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.ownershipPercent.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.ownershipDate.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.ownershipDate.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.primaryRepresentative.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.primaryRepresentative.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.significantResponsibility.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.significantResponsibility.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.politicallyExposed.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.politicallyExposed.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.driversLicenseNumber.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.driversLicenseNumber.fieldConstraints.minLength

string

^[0-9]+$

String-coerced number. Send a numeric string (e.g. "400"). Server coerces via Number().

owners.fields.driversLicenseNumber.fieldConstraints.maxLength

string

^[0-9]+$

String-coerced number. Send a numeric string (e.g. "400"). Server coerces via Number().

owners.fields.driversLicenseNumber.fieldConstraints.allowAlpha

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.driversLicenseNumber.fieldConstraints.allowNumeric

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.driversLicenseNumber.fieldConstraints.allowWhitespace

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.driversLicenseNumber.fieldConstraints.allowedSpecialCharacters

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.driversLicenseNumber.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.driversLicenseState.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.driversLicenseState.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.fields.driversLicenseExpiration.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.fields.driversLicenseExpiration.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.attachments.id.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.attachments.id.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.attachments.idFront.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.attachments.idFront.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.attachments.idBack.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.attachments.idBack.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

owners.attachments.utilityBill.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

owners.attachments.utilityBill.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

banking.fields.account.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

banking.fields.account.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

banking.fields.routing.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

banking.fields.routing.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

banking.fields.accountType.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

banking.fields.accountType.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

banking.fields.accountType.enum

string

enum

Allowed:

banking.fields.accountName.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

banking.fields.accountName.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

banking.fields.nameOnAccount.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

banking.fields.nameOnAccount.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

banking.fields.country.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

banking.fields.country.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

banking.fields.country.enum

string

enum

Allowed:

banking.fields.primaryAccount.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

banking.fields.primaryAccount.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

banking.fields.hasDisbursementHistory.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

banking.fields.hasDisbursementHistory.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

banking.attachments.bankStatement.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

banking.attachments.bankStatement.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

banking.attachments.voidedCheck.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

banking.attachments.voidedCheck.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

attachments.attachments.businessLicense.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

attachments.attachments.businessLicense.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

attachments.attachments.ss4.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

attachments.attachments.ss4.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

attachments.attachments.other.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

attachments.attachments.other.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

attachments.attachments.proofOfEmployment.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

attachments.attachments.proofOfEmployment.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

attachments.attachments.articlesOfIncorporation.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

attachments.attachments.articlesOfIncorporation.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

connectionspecificRequirements.fields.greenskyPrimaryBusinessCategory.display

string

enum

String-coerced boolean. Send literal "true" or "false". Server coerces to boolean via convertStringToBoolean.

Allowed:

connectionspecificRequirements.fields.greenskyPrimaryBusinessCategory.displayAttributes.subText

string

Raw string. Server accepts the value as-is (no coercion).

connectionspecificRequirements.fields.greenskyPrimaryBusinessCategory.enum

string

enum

Headers

idempotency-key

string

Unique key to ensure idempotency of requests. If provided, the server will return the same response for subsequent requests with the same key.

Responses

401

Invalid API key.

500

Unable to service request due to server-side error. Please reattempt request.

200Form Template Updated.