Create Form

post

https://api.preczn.com/v1/forms

Body Params

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

enum

Single connection ID for single-connection forms. Supports both KYC and RFI form types. Provide either connectionId or connectionIds, not both.

Allowed:

connectionIds

array of strings

Array of connection IDs for multi-connection forms (KYC only). Accepts the same connection values as connectionId — any key from CONNECTION_REQUIREMENTS (e.g., Payrix, StripeConnect, Ramp). Provide either connectionId or connectionIds, not both.

connectionIds

Allowed:

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.

displayPciSaq

boolean

Whether or not the PCI SAQ compliance step will display in the form. Only applicable for KYC forms with AFP connections.

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

button

object

Variables that determine the styling of the buttons in form

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.

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

enum

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

Allowed:

customFormFields

object

required

personCompleting

object

Contact details of the person completing the boarding form (name, email, phone, title). All fields are individually optional at form creation; format is validated when a value is present. Does not set lastSectionCompleted.

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.

201Form created. Single-connection forms include processorName (string). Multi-connection forms include processorNames (string[]) and connectionIds (string[]).