API Reference
  1. Preczn API
  2. Boarding Form Templates

Create Form Template

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

Create request body. All values are strings on the wire; the server coerces booleans/numbers/arrays as documented per field. Note that field names containing dots (e.g. businessInfo.fields.name.display) are single multipart part names — the dots are part of the name string, not a traversal into a nested object.

string

Id for the Preczn Platform.

string
enum

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

Allowed:
string
enum

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

Allowed:
string

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

string

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

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.

string
^[0-9]+$

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

string
enum

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

Allowed:
string
enum

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

Allowed:
string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

Title text displayed in the header.

string

Hex color for header text. Default #000000.

string

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

string

Hex color for button text. Default #FFFFFF.

string

Hex color for button background. Default #808080.

string

Website merchants may visit for support or FAQs.

string

Support email address.

string

Support phone number (11 digits, no formatting).

string

Text displayed under the support phone number.

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.

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.

string
enum

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

Allowed:
string

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

string
^[0-9]+$

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

string
^[0-9]+$

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

string
enum

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

Allowed:
string
enum

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

Allowed:
string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
^[0-9]+$

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

string
^[0-9]+$

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

string
enum

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

Allowed:
string
enum

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

Allowed:
string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
^[0-9]+$

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

string
^[0-9]+$

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

string
enum

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

Allowed:
string

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

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:
string
enum

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

Allowed:
string

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

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:
string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
^[0-9]+$

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

string
^[0-9]+$

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

string
enum

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

Allowed:
string
enum

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

Allowed:
string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
^[0-9]+$

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

string
^[0-9]+$

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

string
enum

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

Allowed:
string
enum

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

Allowed:
string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

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:
string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
^[0-9]+$

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

string
^[0-9]+$

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

string
enum

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

Allowed:
string
enum

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

Allowed:
string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string
^[0-9]+$

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

string
^[0-9]+$

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

string
enum

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

Allowed:
string
enum

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

Allowed:
string
enum

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

Allowed:
string

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

string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

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:
string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

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:
string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

string
enum

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

Allowed:
string

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

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.

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 5 days ago

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

Updated 5 days ago

Did this page help you?