KYB (Know Your Business)

The KYB flow verifies the legitimacy of business entities, including company details, registration documents, and associated representatives.

The KYB flow is designed to collect and verify company information, including details about the organization itself, its beneficiaries, and its representatives. It ensures that all relevant entities are identified and verified before completing the onboarding process.

The KYB flow consists of three main steps:

1

Company data

2

Beneficiaries

3

Review

Each step is fully configurable and can include its own parameters.

Flags

flags is an object that contains optional configuration parameters for adjusting the KYB verification flow. Below is a summary of the most commonly used flags:

Flag name	Description	Default	Type
skip_face	Skips the liveness step if it already exists in the defined steps. Prevents duplication when using custom flows.	false	<boolean>
skip_document	Skips the identity-document step if it already exists in the defined steps. Prevents duplication when using custom flows.	false	<boolean>
return_url	URL to redirect the user to after the identification process is completed. If omitted, the session is assumed to be embedded in an iframe.	null	<string>
language	User interface language code. Supported values: "es", "ka", "uk", "ru", "uz", "it", "gr", "tr", "ro", "ar", "de", "pl", "hi", "bn", "az", "ja", "pt", "fr", "kk", "sv"	"en"	<string>
skip_desktop	Limits sessions to mobile devices only. If initiated on desktop, a QR code is shown to transfer the session to a mobile device.	false	<boolean>
switch_device_url	A custom URL to display in the QR code when the camera is unavailable or blocked. If omitted or empty, the QR code will not be displayed.	null	<string>
restrict_url_sharing	Prevents the session URL from being used on a different browser or device. If true, the QR code will not appear when camera access is denied—unless switch_device_url is also defined.	false	<boolean>

Steps

The steps array defines the sequence and structure of the KYB process. It is passed together with the company_key and flags parameters when creating a session.

Each step in the array can contain its own properties properties:

Property	Description
type	The type of the specific step (see list of supported step types below).
key	A unique identifier for the step. This key can be customized but must remain unique within the session.
flags	Step-specific configuration flags that control the behavior of this step.
title	A custom title provided by the client, displayed to the user during this step in the interface.

Supported step types

Below is a list of all step types currently supported in the system:

• Language

• Company data

• Beneficiaries

• Review

• User questionnaire

---

Language

The Language step allows the user to select their preferred interface language at the beginning of the identification process.

Language step configurations:

• Title: Language

• Type: language

• Key: language

• Array of languages

Flag	Description	Default	Type
languages	An array of language codes to display. If left empty, all supported languages will be shown. "en", "ka", "es", "uk", "gr", "it", "de", "ru", "uz", "ro", "tr", "ar", "pl", "bn", "hi", "hy", "az", "ja", "pt", "fr", "kk", "sv"	All	Array<string>

Expand to view example

curl https://widget.identomat.com/external-api/begin/ -d '{
    "company_key": "your_company_key_here",
    "flags": {
        "return_url": "https://example.com/",
        "language": "es"
    } ,
    "steps": [
     {
                "title": {
                  "en": "Language",
                  "ka": "ენა",
                  "es": "Idioma",
                  "uk": "Мова",
                  "gr": "Γλώσσα",
                  "it": "Lingua",
                  "de": "Sprache",
                  "ru": "Язык",
                  "uz": "Til",
                  "ro": "Limbă",
                  "tr": "Dil",
                  "ar": "اللغة",
                  "pl": "Język",
                  "bn": "ভাষা",
                  "hi": "भाषा",
                  "hy": "Լեզու",
                  "az": "Dil",
                  "ja": "言語",
                  "pt": "Idioma",
                  "fr": "Langue",
                  "kk": "Тіл",
                  "sv": "Språk"
                },
                "type": "language",
                "key": "language",
                "languages": [
                    "en",
                    "ka",
                    "es",
                    "uk",
                    "gr",
                    "it",
                    "de",
                    "ru",
                    "uz",
                    "ro",
                    "tr",
                    "ar",
                    "pl",
                    "bn",
                    "hi",
                    "hy",
                    "az",
                    "ja",
                    "pt",
                    "fr",
                    "kk",
                    "sv"
                ]
            },
            {
                "title": {
                  "en": "ID verification",
                  "ka": "პირადობის დადასტურება",
                  "es": "Verificación de identidad",
                  "uk": "Підтвердження особи",
                  "gr": "Επαλήθευση ταυτότητας",
                  "it": "Verifica dell'identità",
                  "de": "Identitätsprüfung",
                  "ru": "Проверка удостоверения личности",
                  "uz": "Shaxsni tasdiqlash",
                  "ro": "Verificare a identității",
                  "tr": "Kimlik doğrulama",
                  "ar": "التحقق من الهوية",
                  "pl": "Weryfikacja tożsamości",
                  "bn": "পরিচয় যাচাই",
                  "hi": "पहचान सत्यापन",
                  "hy": "Անձնագրի հաստատում",
                  "az": "Şəxsiyyətin təsdiqi",
                  "ja": "本人確認",
                  "pt": "Verificação de identidade",
                  "fr": "Vérification d'identité",
                  "kk": "Жеке басын тексеру",
                  "sv": "ID-verifiering"
            },
                "type": "identity-document",
                "key": "select_document_id-1",
                "flags": {
                    "document_types": [
                        "id",
                        "passport",
                        "driver_license",
                        "residence_license"
                    ],
                    "allow_document_upload": false,
                    "disable_document_capture": false
                }
            }
    ]
}'

---

Company data

This step collects the core information about the company.

• Title: Company data

• Description: Follow the simple steps below

• Type: company

• Key: company

• Fields:

  • Company name (always mandatory)

  • Registration number (always mandatory)

  • Registration country (always mandatory)

  • Type of entity

  • Legal adress

  • VAT / TaxID

  • Date of Incorporation

  • Contact number

  • Contact email address

Step example:

{
  "type": "company",
  "key": "company",
  "title": { "en": "Company data" },
  "description": { "en": "Follow the simple steps below" },
  "fields": [...]
}

Step parameters:

Parameter	Description	Type
type	Step type. Must be company.	<string>
key	Unique identifier for the step.	<string>
title	Localized title text displayed as the block title to the user. The title can be an <object> containing different languages, allowing the title to be displayed in the selected language during the flow.	<object>
description	A description that appears below the title on the user's side. Similar to the title, the description can be an <object> containing different languages, so that it can be displayed in the selected language during the flow.	<object>
fields	List of fields to be collected during this step.	<array>

Fields:

Example:

"fields": [
                  { "type": "companyName", "mandatory": true },
                  { "type": "registrationNumber", "mandatory": true },
                  { "type": "registrationCountry", "mandatory": true },
                  { "type": "ownershipPercentage", "mandatory": false },
                  { "type": "companyEntityType", "mandatory": false },
                  { "type": "legalAddress", "mandatory": false },
                  { "type": "taxId", "mandatory": false },
                  { "type": "dateOfIncorporation", "mandatory": false },
                  { "type": "firstName", "mandatory": true },
                  { "type": "lastName", "mandatory": true },
                  { "type": "dateOfBirth", "mandatory": true },
                  { "type": "contactNumber", "mandatory": false },
                  { "type": "email", "mandatory": false }, 
                  { "type": "website", "mandatory": false }
              ]

Field	Description	Input type
companyEntityType	Mandatory field. Type of legal entity. Options include: Limited liability company Publicly listed company Sole proprietor Partnership Corporation Trust Private foundation Charity Nonprofit organization Other	Dropdown
companyName	Mandatory field. Official registered company name.	Text input
registrationNumber	Mandatory field. Company registration number.	Text input
registrationCountry	Mandatory field. Country of incorporation. Options: all countries list.	Dropdown
legalAddress	Company’s registered legal address.	Text input
taxId	Tax identification number.	Text input
dateOfIncorporation	Company incorporation date.	Date picker
contactNumber	Company contact phone number.	Text input
email	Company contact email address.	Text input

---

Beneficiaries

The Beneficiaries step collects information about all individuals or companies with roles in the organization.

Each role can trigger either a KYC or KYB verification flow.

Supported roles:

• Shareholder – can be either an individual or another company

• UBOs (Ultimate Beneficial Owner) – always an individual with ownership/control

• Director – individual member of the board

• Representative – authorized individual acting on behalf of the company

• Other – custom role (requires position name)

Step example:

{
  "type": "beneficiaries",
  "key": "beneficiaries",
  "title": { "en": "Beneficiaries" },
  "description": { "en": "Enter information about the company's beneficiaries" },
  "roles": { ... },
  "kycConfigId": "687e0ba12cf633bd323cb0db",
  "kybConfigId": "687e0ba12cf633bd323cb0d2"
}

Step parameters:

Parameter	Description	Type
type	Step type. Must be beneficiaries.	<string>
key	Unique identifier for the step.	<string>
title	Localized title text displayed as the block title to the user. The title can be an <object> containing different languages, allowing the title to be displayed in the selected language during the flow.	<object>
description	A description that appears below the title on the user's side. Similar to the title, the description can be an <object> containing different languages, so that it can be displayed in the selected language during the flow.	<object>
kycConfigId	ID of the KYC configuration applied to individuals.	<string>
kybConfigId	ID of the KYB configuration applied to companies.	<string>
roles	Defines roles (shareholder, ubo, director, representative, other).	<object>

Role: Shareholder

• Can be either an individual or a company.

• verification: true → triggers a verification flow

  • Individual → KYC (kycConfigId)

  • Company → KYB (kybConfigId)

Important: Pre-created KYC and KYB configurations are required for shareholder verification flows. These configurations define which verification steps (e.g., document upload, selfie, questionnaire) will be applied during the process. To learn how to create and manage KYC configurations, refer to the KYC developer's guide or KYC configuration guide.

Role example:

"roles": {
        "shareholder": {
              "fields": [
                  { "type": "ownershipPercentage", "mandatory": false },
                  { "type": "companyName", "mandatory": true },
                  { "type": "companyEntityType", "mandatory": false },
                  { "type": "registrationNumber", "mandatory": true },
                  { "type": "registrationCountry", "mandatory": true },
                  { "type": "legalAddress", "mandatory": false },
                  { "type": "taxId", "mandatory": false },
                  { "type": "dateOfIncorporation", "mandatory": false },
                  { "type": "firstName", "mandatory": true },
                  { "type": "lastName", "mandatory": true },
                  { "type": "dateOfBirth", "mandatory": true },
                  { "type": "contactNumber", "mandatory": false },
                  { "type": "email", "mandatory": false }, 
                  { "type": "website", "mandatory": false }
              ],
              "verification": true
        }
}

Shareholder fileds:

Field	Description	Input type	Applies to
ownershipPercentage	Percentage of ownership in the company.	Text input	Company / Individual
companyName	Mandatory field. Official registered company name.	Text input	Company
registrationNumber	Mandatory field. Shareholder company registration number.	Text input	Company
registrationCountry	Mandatory field. Country of incorporation. Options: all countries list.	Dropdown	Company
companyEntityType	Mandatory field. Type of legal entity. Options include: Limited liability company Publicly listed company Sole proprietor Partnership Corporation Trust Private foundation Charity Nonprofit organization Other	Dropdown	Company
legalAddress	Registered legal address of shareholder company.	Text input	Company
taxId	Tax identification number.	Text input	Company
dateOfIncorporation	Company incorporation date.	Date picker	Company
website	Company website.	Input	Company
contactNumber	Contact phone number.	Text input	Company / Individual
email	Contact email address.	Text input	Company / Individual
firstName	Mandatory field. Individual's first name.	Text input	Individual
lastName	Mandatory field. Individual's last name.	Text input	Individual
dateOfBirth	Mandatory field. Individual's date of birth.	Date picker	Individual

Role: UBOs

• Always an individual.

• verification: true → triggers KYC flow (kycConfigId)

Important: Pre-created KYC configuration is required for UBOs verification flows. These configurations define which verification steps (e.g., document upload, selfie, questionnaire) will be applied during the process. To learn how to create and manage KYC configurations, refer to the KYC developer's guide or KYC configuration guide.

Role example:

"roles": {
            "ubo": {
              "fields": [
                { "type": "firstName", "mandatory": true },
                { "type": "lastName", "mandatory": true },
                { "type": "dateOfBirth", "mandatory": true },
                { "type": "ownershipPercentage", "mandatory": false },
                { "type": "email", "mandatory": false },
                { "type": "contactNumber", "mandatory": false }
              ],
              "verification": true
        }
}

UBOs fields:

Field	Description	Input type
firstName	Mandatory field. Individual's first name.	Text input
lastName	Mandatory field. Individual's last name.	Text input
dateOfBirth	Mandatory field. Individual's date of birth.	Date picker
ownershipPercentage	Percentage of ownership in the company.	Text input
contactNumber	Company contact phone number.	Text input
email	Company contact email address.	Text input

Role: Director

• Always an individual.

• verification: true → triggers KYC flow (kycConfigId)

Important: Pre-created KYC configuration is required for Director verification flows. These configurations define which verification steps (e.g., document upload, selfie, questionnaire) will be applied during the process. To learn how to create and manage KYC configurations, refer to the KYC developer's guide or KYC configuration guide.

Role example:

"roles": {
          "director": {
              "fields": [
                { "type": "firstName", "mandatory": true },
                { "type": "lastName", "mandatory": true },
                { "type": "dateOfBirth", "mandatory": true },
                { "type": "email", "mandatory": false },
                { "type": "contactNumber", "mandatory": false }
              ],
              "verification": true
        }
}

Director fields:

Field	Description	Input type
firstName	Mandatory field. Individual's first name.	Text input
lastName	Mandatory field. Individual's last name.	Text input
dateOfBirth	Mandatory field. Individual's date of birth.	Date picker
contactNumber	Company contact phone number.	Text input
email	Company contact email address.	Text input

Role: Representative

• Always an individual.

• verification: true → triggers KYC flow (kycConfigId)

Important: Pre-created KYC configuration is required for Representative verification flows. These configurations define which verification steps (e.g., document upload, selfie, questionnaire) will be applied during the process. To learn how to create and manage KYC configurations, refer to the KYC developer's guide or KYC configuration guide.

Role example:

"roles": {
          "representative": {
              "fields": [
                { "type": "firstName", "mandatory": true },
                { "type": "lastName", "mandatory": true },
                { "type": "dateOfBirth", "mandatory": true },
                { "type": "email", "mandatory": false },
                { "type": "contactNumber", "mandatory": false }
              ],
              "verification": true
        }
}

Representative fields:

Field	Description	Input type
firstName	Mandatory field. Individual's first name.	Text input
lastName	Mandatory field. Individual's last name.	Text input
dateOfBirth	Mandatory field. Individual's date of birth.	Date picker
contactNumber	Company contact phone number.	Text input
email	Company contact email address.	Text input

Role: Other

• Always an individual.

• verification: true → triggers KYC flow (kycConfigId)

Important: Pre-created KYC configuration is required for Other role verification flows. These configurations define which verification steps (e.g., document upload, selfie, questionnaire) will be applied during the process. To learn how to create and manage KYC configurations, refer to the KYC developer's guide or KYC configuration guide.

Role example:

"roles": {
          "other": {
              "fields": [
                { "type": "positionName", "mandatory": true },
                { "type": "firstName", "mandatory": true },
                { "type": "lastName", "mandatory": true },
                { "type": "dateOfBirth", "mandatory": true },
                { "type": "email", "mandatory": false },
                { "type": "contactNumber", "mandatory": false }
              ],
              "verification": true
        }
}

Fields:

Field	Description	Input type
positionName	Mandatory field. Position title (e.g., advisor)	Text input
firstName	Mandatory field. Individual's first name.	Text input
lastName	Mandatory field. Individual's last name.	Text input
dateOfBirth	Mandatory field. Individual's date of birth.	Date picker
contactNumber	Company contact phone number.	Text input
email	Company contact email address.	Text input

---

Review

The Review step presents a summary of all collected company and beneficiary data before submission. Applicants can review and edit information if needed.

Example:

{
  "type": "kyb-review",
  "key": "kyb-review",
  "title": {
    "en": "Checking the data",
    "es": "Verificando los datos"
  },
  "description": {
    "en": "Please check the information below to make sure everything is correct",
    "es": "Por favor revise la información a continuación para asegurarse de que todo esté correcto"
  }
}

This step allows the applicant to edit the data before submission.

KYB cURL example:

Expand to view example

curl https://widget.identomat.com/external-api/begin/ -d '{
"company_key": "your_company_key_here",
"flags": {
        "return_url": "https://example.com/",
        "language": "en"
},
  "steps": [
        {
          "type": "company",
          "key": "company",
          "title": {
            "en": "Company data"
          },
          "description": {
            "en": "Follow the simple steps below"
          },
          "fields": [
               { "type": "companyName", "mandatory": true },
               { "type": "companyEntityType", "mandatory": false },
               { "type": "registrationNumber", "mandatory": true },
               { "type": "registrationCountry", "mandatory": true },
               { "type": "legalAddress", "mandatory": true },
               { "type": "taxId", "mandatory": false },
               { "type": "dateOfIncorporation", "mandatory": false },
               { "type": "contactNumber", "mandatory": false },
               { "type": "email", "mandatory": false }
          ]
        },
        {
          "type": "beneficiaries",
          "key": "beneficiaries",
          "title": {
            "en": "Beneficiaries"
          },
          "description": {
            "en": "Enter information about the company's beneficiaries"
          },
          "kycConfigId": "687e0ba12cf633bd323cb0db",
          "kybConfigId": "687e0ba12cf633bd323cb0d2",
          "roles": {
            "shareholder": {
              "fields": [
                  { "type": "ownershipPercentage", "mandatory": false },
                  { "type": "companyName", "mandatory": true },
                  { "type": "companyEntityType", "mandatory": false },
                  { "type": "registrationNumber", "mandatory": true },
                  { "type": "registrationCountry", "mandatory": true },
                  { "type": "legalAddress", "mandatory": false },
                  { "type": "taxId", "mandatory": false },
                  { "type": "dateOfIncorporation", "mandatory": false },
                  { "type": "firstName", "mandatory": true },
                  { "type": "lastName", "mandatory": true },
                  { "type": "dateOfBirth", "mandatory": true },
                  { "type": "contactNumber", "mandatory": false },
                  { "type": "email", "mandatory": false }, 
                  { "type": "website", "mandatory": false }
              ],
              "verification": true
            },
            "ubo": {
              "fields": [
                { "type": "ownershipPercentage", "mandatory": true },
                { "type": "firstName", "mandatory": true },
                { "type": "lastName", "mandatory": true },
                { "type": "dateOfBirth", "mandatory": true },
                { "type": "email", "mandatory": false },
                { "type": "contactNumber", "mandatory": false }
              ],
              "verification": true
            },
            "director": {
              "fields": [
                { "type": "firstName", "mandatory": true },
                { "type": "lastName", "mandatory": true },
                { "type": "dateOfBirth", "mandatory": true },
                { "type": "email", "mandatory": false },
                { "type": "contactNumber", "mandatory": false }
              ],
              "verification": true
            },
            "representative": {
              "fields": [
                { "type": "firstName", "mandatory": true },
                { "type": "lastName", "mandatory": true },
                { "type": "dateOfBirth", "mandatory": true },
                { "type": "email", "mandatory": false },
                { "type": "contactNumber", "mandatory": false }
              ],
              "verification": true
            },
            "other": {
              "fields": [
                { "type": "positionName", "mandatory": true },
                { "type": "firstName", "mandatory": true },
                { "type": "lastName", "mandatory": true },
                { "type": "dateOfBirth", "mandatory": true },
                { "type": "email", "mandatory": false },
                { "type": "contactNumber", "mandatory": false }
              ],
              "verification": true
            }
          }
        },
        {
          "type": "kyb-review",
          "key": "kyb-review",
          "title": {
            "en": "Checking the data"
          },
          "subtitle": {
            "en": "Please check the information below to make sure everything is correct"
          }
        }
      ]
}'

---

User questionnaire

The user questionnaire step allows you to collect custom user input as part of the verification flow. It supports various question types and provides multilingual support for titles and descriptions. All responses are saved to the verification session. This step has a slightly different structure compared to other steps.

User questionnaire step configurations:

• type Must be set to "user-questionnaire" to define this step as a user questionnaire block.

• key A client-defined unique key for this questionnaire step. It must remain unique within a single session to avoid conflicts.

• title The main title of the questionnaire displayed on the user interface. Must always be provided as an <object> with language codes as keys (e.g., "en"), even if only one language is used. This ensures consistency and supports future localization.

• description Text displayed beneath the title in the user interface, providing context or instructions. Must always be an <object> of language codes. Same format and rules as title.

• questions An <array> of question objects to be presented to the user. Supported question types include:

  • string: Text Input – The user enters a short text answer.

  • multiple-choice: : Checkboxes – Allows the user to select one or more options.

  • options: Radio – The user selects a single option from a list.

  • dropdown : Dropdown List – The user selects one or more options from a dropdown menu.

  • file: File Upload – Allows the user to upload a file as a response.

  • attachment: Attachment - Allows attaching files either dynamically (via API/configuration) or per session. Depending on configuration, files may be pre-attached for the user or uploaded by the operator during the session.

• successButtonTitle Defines the label of the confirmation button displayed at the end of the questionnaire. Must also be an <object> of language codes, even if only one language is used. If any question is marked as "mandatory": true, the button will remain disabled until all required questions are answered.

Questions

Each question in the questions array supports a set of parameters that define how it behaves and appears to the user. Here's a breakdown of all supported properties:

• type Defines the question type. Supported values:

  • string – Short text input

  • multiple-choice – Checkbox (multiple selection)

  • options– Radio buttons (single selection)

  • dropdown– Dropdown menu (single or multi-select)

  • file– File upload

  • attachment - Attach files and share with the end-user

• title A multilingual <object> representing the question label. Example:

"title": {
  "en": "What is your occupation?",
  "fr": "Quelle est votre profession ?"
}

• key A unique identifier for the question within the same questionnaire. This is client-defined and used for referencing and data mapping.

• mandatory Indicates whether the question must be answered before the user can proceed.

  • Value: true or false

• answer Allows you to preset an answer for the user.

  • string: A plain text string (e.g., "John Doe").

  • options: A single option key (e.g., "opt_a").

  • multiple-choice: An array of option keys (e.g., ["opt_a", "opt_c"]).

  • dropdown: Not applicable.

  • file: Not applicable.

  • attachment: An array of file IDs

  Note: End-users can modify pre-filled answers unless readOnly is enabled.

• readOnly Displays the question in a non-editable state. Users can view the question and answer but cannot change it.

  • Value: true or false

• showConditions Defines a conditional display rule for the question, based on the answer to a previous question.

  • questionKey Key of the controlling question.

  • answer Key of the answer (for radio/checkbox) or specific text (for string)

"showConditions": {
  "questionKey": "employment-status",
  "answer": "self-employed"
}

• multiple Specific to dropdown type.

  • If true, the user can select multiple values from the dropdown.

  • Value: true or false

Options

Options are used exclusively in multiple-choice , options and dropdown type questions. They define the selectable choices that the user can pick from.

Each question that supports options must include the following parameter:

• options An <array> of option objects for the question. Each object must include the following:

• title The text label for the option, shown to the user during the verification flow. Must always be provided as an <object> with language codes as keys, even if only one language is used. This ensures consistency across multilingual flows. Example:

{
  "en": "Self-employed"
}

• key A unique identifier for the option within the questionnaire. This value is used for referencing in preset answers, conditions, and session data. It must be unique within the same questionnaire to avoid conflicts.

List of parameters with examples:

Parameter	Description	Default	Type	Example
key	Keys are chosen by the client and must remain unique within a single session. Recommended to use key describing the questionnaire shortly.	-	<string>	"key": "terms-and-conditions"
title	The title of the user questionnaire, displayed as the block title on the user's side. The title can be an <object> containing different languages, allowing the title to be displayed in the selected language during the verification flow.	-	<object>	"title": { "es": "Tu título", "en": "Your title" }
description	A description that appears below the title on the user's side. Similar to the title, the description can be an <object> containing different languages, so that it can be displayed in the selected language during the verification flow.	-	<object>	"description": { "es": "Tu descripción", "en": "Your description" }
questions	An <array> of questions with the following types: string, multiple-choice , options, dropdown.	-	<array>	"questions": [ { "type": "string", "title": { "es": "Tu título", "en": "Your title" } "key": "question1", "mandatory": true }, { "type": "multiple-choice", "title": { "es": "Tu título", "en": "Your title" }, "key": "question2", "mandatory": false, "options": [ { "title": { "es": "Tu título", "en": "Your title" }, "key": "option1" }, { "title": { "es": "Tu título", "en": "Your title" }, "key": "option2" } ] } ]
mandatory	Specifies whether the question is required to be answered. Possible values: true, false	false	<boolean>	"mandatory": false
answer	Allows to preset an answer for a question.	-	<string> or <array>	"answer": "option2"
readOnly	Displays the question but restricts interaction.	false	<boolean>	"readOnly": false
showConditions	This parameter may be used to set conditions for whether a question should be displayed.	-	<object>	"showConditions": { "questionKey": "question1", "answer": "option1" }
successButtonTitle	The title of the action button in the questionnaire. If the questions are mandatory, the button is deactivated until the user completes the questionnaire.	Confirm	<object>	"successButtonTitle": { "es": "Tu título", "en": "Your title" }

cURL example:

Expand to view user-questionnaire example

curl https://widget.identomat.com/external-api/begin/ -d '{
"company_key": "your_company_key_here",
"flags": {
        "restrict_url_sharing": true,
        "language": "es"
},
"steps": [
    {
            "key": "questionnaire-page-1",
            "type": "user-questionnaire",
            "title": { 
                "es": "Tu título",
                "en": "Your title"
                },
            "description": {
                "es": "Tu descripción",
                "en": "Your description"
                },
            "questions": [
                {
                "type": "string",
                "title": {
                "es": "Tu título",
                "en": "Your title"
                },
                "key": "question1",
                "mandatory": true
                },
                {
                "type": "multiple-choice",
                "title": {
                "es": "Tu título",
                "en": "Your title"
                },
                "key": "question2",
                "mandatory": false,
                "options": [
                    {
                    "title": {
                    "es": "Tu título",
                    "en": "Your title"
                    },
                    "key": "option1"
                    },
                    { 
                    "title": {
                    "es": "Tu título",
                    "en": "Your title"
                    },
                    "key": "option2"
                    }
                ],
                "answer": ["option2"],
                "readOnly": true
                },
                {
                "type": "options",
                "title": {
                "es": "Tu título",
                "en": "Your title"
                },
                "key": "question3",
                "mandatory": true,
                "options": [
                    {
                    "title": {
                    "es": "Tu título",
                    "en": "Your title"
                    },
                    "key": "option3"
                    },
                    { 
                    "title": {
                    "es": "Tu título",
                    "en": "Your title"
                    },
                    "key": "option4"
                    }
                ]
            }
        ]
    }
]
}'

Question type: Text input

Available parameters:

Parameter	Description	Default	Type	Example
type	string	-	<string>	"type": "string"
key	Keys are chosen by the client and must remain unique within a single session. Recommended to use key describing the question shortly.	-	<string>	"key": "your-address"
title	The title is an <object> of languages so that if the user changes the language during the verification flow, the question can be displayed in different languages. There are no length or symbol restrictions.	-	<object>	"title": { "es": "Tu título", "en": "Your title" }
mandatory	Specifies whether the question is required to be answered. Possible values: true, false	false	<boolean>	"mandatory": true
answer	Allows to preset an answer for a question. The answer is an <object> of languages so that if the user changes the language during the verification flow, the prefilled answer can be displayed in different languages.	-	<object>	"answer": { "en": "This is a prefilled answer", "es":"Esta es una respuesta prellenada." }
readOnly	Displays the question but restricts interaction.	false	<boolean>	"readOnly": true
showConditions	This parameter may be used to set conditions for whether a question should be displayed.	-	<object>	"showConditions": { "questionKey": "question1", "answer": "option1" }

Expand to view TEXT INPUT question example

"questions": [
    {
        "type": "string",
        "title": {
            "es": "Tu título",
            "en": "Your title"
        },
        "key": "question1",
        "mandatory": true,
        "answer": {
            "en": "This is a prefilled answer",
            "es": "Esta es una respuesta prellenada."
        },
        "showConditions": {
            "questionKey": "question1",
            "answer": "option1"
        },
        "readOnly": true
    }
]

---

Question type: Checkbox

Available parameters:

Parameter	Description	Default	Type	Example
type	multiple-choice	-	<string>	"type": "multiple-choice"
key	Keys are chosen by the client and must remain unique within a single session. Recommended to use key describing the question shortly.	-	<string>	"key": "check-two-answers"
title	The title is an <object> of languages so that if the user changes the language during the verification flow, the question can be displayed in different languages. There are no length or symbol restrictions.	-	<object>	"title": { "es": "Tu título", "en": "Your title" }
options	An <array> of options for the question. Each option may have: "title" : The title of an option. The title is an <object> containing different languages, allowing the option to be displayed in the selected language during the verification flow. "key": The key for the option, chosen by the client. It must remain unique within a single questionnaire.	-	<array>	"options": [ { "title": { "en": "Identity Document", "es": "Documento de identidad" }, "key": "identity-document" }, { "title": { "en": "Proof of Address", "es": "Comprobante de domicilio" }, "key": "proof-of-address" ]
mandatory	Specifies whether the question is required to be answered. Possible values: true, false	false	<boolean>	"mandatory": true
answer	Allows to preset an answer for a question. The answer is an <array> of option keys assigned to this question.	-	<array>	"answer": [ "option-1", "option-2" ]
readOnly	Displays the question but restricts interaction.	false	<boolean>	"readOnly": true
showConditions	This parameter may be used to set conditions for whether a question should be displayed.	-	<object>	"showConditions": { "questionKey": "question1", "answer": "option1" }

Expand to view CHECKBOX question example

"questions": [
    {
        "type": "multiple-choice",
        "title": {
            "es": "Tu título",
            "en": "Your title"
        },
        "key": "question2",
        "options": [
            {
                "title": {
                    "en": "Identity Document",
                    "es": "Documento de identidad"
                },
                "key": "identity-document"
            },
            {
                "title": {
                    "en": "Proof of Address",
                    "es": "Comprobante de domicilio"
                },
                "key": "proof-of-address"
            ],
            "mandatory": true,
            "answer": [
                "identity-document",
                "proof-of-address"
            },
            "showConditions": {
                "questionKey": "question1",
                "answer": "option1"
            },
            "readOnly": true
        }
    ]

---

Question type: Radio

Available parameters:

Parameter	Description	Default	Type	Example
type	options	-	<string>	"type": "options"
key	Keys are chosen by the client and must remain unique within a single session. Recommended to use key describing the question shortly.	-	<string>	"key": "choose-one-answer"
title	The title is an <object> of languages so that if the user changes the language during the verification flow, the question can be displayed in different languages. There are no length or symbol restrictions.	-	<object>	"title": { "es": "Tu título", "en": "Your title" }
options	An <array> of options for the question. Each option may have: "title" : The title of an option. The title is an <object> containing different languages, allowing the option to be displayed in the selected language during the verification flow. "key": The key for the option, chosen by the client. It must remain unique within a single questionnaire.	-	<array>	"options": [ { "title": { "en": "Identity Document", "es": "Documento de identidad" }, "key": "identity-document" }, { "title": { "en": "Proof of Address", "es": "Comprobante de domicilio" }, "key": "proof-of-address" ]
mandatory	Specifies whether the question is required to be answered. Possible values: true, false	false	<boolean>	"mandatory": true
answer	Allows to preset an answer for a question. The answer is an <string> of an option key assigned to this question.	-	<string>	"answer": "option-1"
readOnly	Displays the question but restricts interaction.	false	<boolean>	"readOnly": true
showConditions	This parameter may be used to set conditions for whether a question should be displayed.	-	<object>	"showConditions": { "questionKey": "question1", "answer": "option1" }

Expand to view RADIO question example

"questions": [
    {
        "type": "options",
        "title": {
            "es": "Tu título",
            "en": "Your title"
        },
        "key": "question3",
        "options": [
            {
                "title": {
                    "en": "Identity Document",
                    "es": "Documento de identidad"
                },
                "key": "identity-document"
            },
            {
                "title": {
                    "en": "Proof of Address",
                    "es": "Comprobante de domicilio"
                },
                "key": "proof-of-address"
            ],
            "mandatory": true,
            "answer": "identity-document",
            "showConditions": {
                "questionKey": "question1",
                "answer": "option1"
            },
            "readOnly": true
        }
    ]

---

Question type: Dropdown

Available parameters:

Parameter	Description	Default	Type	Example
type	dropdown	-	<string>	"type": "dropdown"
key	Keys are chosen by the client and must remain unique within a single session. Recommended to use key describing the question shortly.	-	<string>	"key": "choose-from-list"
title	The title is an <object> of languages so that if the user changes the language during the verification flow, the question can be displayed in different languages. There are no length or symbol restrictions.	-	<object>	"title": { "es": "Tu título", "en": "Your title" }
options	An <array> of options for the question. Each option may have: "title" : The title of an option. The title is an <object> containing different languages, allowing the option to be displayed in the selected language during the verification flow. "key": The key for the option, chosen by the client. It must remain unique within a single questionnaire.	-	<array>	"options": [ { "title": { "en": "Identity Document", "es": "Documento de identidad" }, "key": "identity-document" }, { "title": { "en": "Proof of Address", "es": "Comprobante de domicilio" }, "key": "proof-of-address" ]
mandatory	Specifies whether the question is required to be answered. Possible values: true, false	false	<boolean>	"mandatory": true
multiple	Specifies whether the question is single or multiple choice. Possible values: true, false	false	<boolean>	"multiple": true
showConditions	This parameter may be used to set conditions for whether a question should be displayed.	-	<object>	"showConditions": { "questionKey": "question1", "answer": "option1" }

Expand to view DROPDOWN question example

"questions": [
    {
        "type": "options",
        "title": {
            "es": "Tu título",
            "en": "Your title"
        },
        "key": "question4",
        "options": [
            {
                "title": {
                    "en": "Identity Document",
                    "es": "Documento de identidad"
                },
                "key": "identity-document"
            },
            {
                "title": {
                    "en": "Proof of Address",
                    "es": "Comprobante de domicilio"
                },
                "key": "proof-of-address"
            ],
            "mandatory": true,
            "multiple": true,
            "showConditions": {
                "questionKey": "question1",
                "answer": "option1"
            }
        }
    ]

---

Question type: File upload

Available parameters:

Parameter	Description	Default	Type	Example
type	file	-	<string>	"type": "file"
key	Keys are chosen by the client and must remain unique within a single session. Recommended to use key describing the question shortly.	-	<string>	"key": "choose-from-list"
title	The title is an <object> of languages so that if the user changes the language during the verification flow, the question can be displayed in different languages. There are no length or symbol restrictions.	-	<object>	"title": { "es": "Tu título", "en": "Your title" }
description	A description that appears below the title. Similar to the title, the description can be an <object> containing different languages, so that it can be displayed in the selected language during the verification flow.	-	<object>	"description": { "es": "Tu descripción", "en": "Your description" }
mandatory	Specifies whether the question is required to be answered. Possible values: true, false	false	<boolean>	"mandatory": true
fileTypes	Specifies the types of files the user is allowed to upload. Possible values: pdf, image.	[ "pdf", "image" ]	<array>	"fileTypes": [ "pdf", "image" ]
filesMaxCount	Specifies the maximum number of files the user is allowed to upload. Possible values: A number from 1 to 10.	10	<number>	"filesMaxCount": 5
showConditions	This parameter may be used to set conditions for whether a question should be displayed.	-	<object>	"showConditions": { "questionKey": "question1", "answer": "option1" }

Expand to view FILE UPLOAD question example

"questions": [
    {
        "type": "file",
        "title": {
            "es": "Tu título",
            "en": "Your title"
        },
        "key": "question5",
            "mandatory": true,
            "fileTypes": [
            "pdf",
            "image"
            ],
            "filesMaxCount": 5,
            "showConditions": {
                "questionKey": "question1",
                "answer": "option1"
            }
        }
    ]

---

Question type: Attachment

The Attachment question type allows attaching files to a questionnaire. It supports two main use cases:

1. Operator-added attachments per session The operator uploads files during or before the verification session and shares them with the end-user.

2. Predefined attachments from Configuration or API Files are uploaded in the Configuration interface or dynamically provided via API. These files are automatically included in future sessions.

Behavior

• Attachments are visible to both the operator and the end-user.

• When files are provided via API (answer) or Configuration, they will appear when the questionnaire is opened.

• Depending on settings, the operator may be allowed or restricted from modifying attachments after the user has confirmed the questionnaire.

Available parameters:

Parameter	Description	Default	Type	Example
type	attachment	-	<string>	"type": "attachment"
key	Keys are chosen by the client and must remain unique within a single session. Recommended to use key describing the question shortly.	-	<string>	"key": "attached-documents"
title	The title is an <object> of languages so that if the user changes the language during the verification flow, the question can be displayed in different languages. There are no length or symbol restrictions.	-	<object>	"title": { "es": "Tu título", "en": "Your title" }
description	A description that appears below the title. Similar to the title, the description can be an <object> containing different languages, so that it can be displayed in the selected language during the verification flow.	-	<object>	"description": { "es": "Tu descripción", "en": "Your description" }
fileTypes	Specifies the types of files the user is allowed to upload. Possible values: pdf, image.	[ "pdf", "image" ]	<array>	"fileTypes": [ "pdf", "image" ]
filesMaxCount	Specifies the maximum number of files the user is allowed to upload. Possible values: A number from 1 to 10.	10	<number>	"filesMaxCount": 5
showConditions	This parameter may be used to set conditions for whether a question should be displayed.	-	<object>	"showConditions": { "questionKey": "question1", "answer": "option1" }
allowOperatorUpload	Controls how files are added: • true – operator uploads files per session. • false – files are provided via Configuration or API only.	true	<boolean>	"allowOperatorUpload": true
allowOperatorOverride	If false, the operator cannot edit attachments after the user confirms the questionnaire. If true, the operator may still upload or remove files.	true	<boolean>	"allowOperatorOverride": true

Expand to view ATTACHMENT question example

"questions": [
    {
        "type": "attachment",
        "title": {
            "es": "Tu título",
            "en": "Your title"
        },
        "description": {
            "es": "Tu descripción",
            "en": "Your description"
            },
        "key": "question5",
        "fileTypes": [
            "pdf",
            "image"
            ],
        "filesMaxCount": 5,
        "allowOperatorUpload": true,
        "allowOperatorOverride": true,
        "answer": [ ],
        "showConditions": {
            "questionKey": "question1",
            "answer": "option1"
            }
        }
    ]