API Reference

Create Form Template

post
https://api.preczn.com/v1/formTemplates
Body Params
string

Id for the Preczn Platform

boolean

Boolean for determining if the form-template is for Test Mode

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.

string
required

The form template name.

string
required

A list of domains configured for your platform.

string

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

string

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

string

URL with your brand's terms of service.

number
required
1 to 2160
Defaults to 24

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

boolean

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

boolean

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

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.

string

Custom favicon image for this form template. Supported formats: .ico, .png, .svg. Maximum dimensions: 64x64 pixels. Maximum size: 512 KB.

heading
object

Variables used to populate the header of the form webpage.

button
object
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.

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.

string
Defaults to KYC

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

customFormFields
object
Headers
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.

Updated 7 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago