Types

FlowTemplate

A ready-made onboarding journey, defined in code.

idrequired
string
The template's key, such as `uk-investor-categorisation`. It is text, not a uuid.
namerequired
string
The template's name. A flow made from it takes this name unless you send another.
descriptionrequired
string
What the template is for.
regionrequired
string
The regime the template serves: `US`, `UK`, `EU`, `GLOBAL`, `ADVISER` (advisers) or `KYC` (identity checks).One of: US, UK, EU, GLOBAL, ADVISER, KYC
regulatory_basisrequired
string
The rule or guidance the template follows.
page_countrequired
integer
How many pages, and so forms, the template has.
field_countrequired
integer
How many fields the pages have in all.
classificationsrequired
The classifications a respondent can earn through the template.

Used by (1)