# Dashboard Your central hub for updates, quick links, and key resources — access new features, integrations, and documentation all in one place. ## Release notes {% hint style="info" %} 17.08.2026 **AnyDoc reader step now available – August 2026** Introducing **AnyDoc**, a new step that lets you extract structured data from any document type using AI - payslips, bank statements, utility bills, tax declarations, and more. Define the fields you want extracted, configure validity rules and confidence thresholds, and the system reads and validates the data automatically. Available in both the **No-code workflow builder** and via **API**.

{% endhint %} {% hint style="info" %} 11.08.2026 **Group management now available in Manage – August 2026** **Groups**, previously manageable only via the **API**, can now be **created, edited, and deleted directly in the Manage backoffice**. Assign and update group membership without writing any code - ideal for day-to-day operator and routing management.

{% endhint %} {% hint style="info" %} 14.01.2026 **NFC support added to SDKs – January 2026** We’ve added **NFC reading support to our SDKs**, enabling secure chip-based verification for supported identity documents such as biometric passports and IDs.\ With this update, you can read data directly from the document's NFC chip for improved data accuracy. NFC capture can be enabled via configuration and is supported on compatible devices.

Developer guide

{% endhint %} {% hint style="info" %} 25.08.2025 **KYB now available - August 2025** We’ve introduced **Know Your Business (KYB)** verification to help you onboard legal entities and organizations with the same flexibility as KYC. You can now create KYB sessions directly through the **API** or configure them seamlessly in the **No-code workflow builder**. This makes it easier than ever to integrate business verification into your processes.

Developer guide Build with no-code

{% endhint %} ## **Quick access**


Product overview	Learn what Identomat offers, core features, and how it helps you streamline identity verification.	/pages/UhDvrEwKiEEkYSQDU29s
Get started	Step-by-step guide to set up your account, configure roles, and launch your first verification flow.	/pages/jsSamWGbuqg1PP1VQba9
No-code workflow builder	Easily design and customize verification flows without coding, using drag-and-drop configurations.	/pages/Vh2KVAtSKWFjwhJLdTBn
Video KYC	Understand how live video identification works for operators and end-users, including compliance controls.	/pages/qMezYAra47sEuMJsn6z8
Integration	Explore different ways to integrate Identomat into your systems — via iframe, redirect, or backoffice.	/pages/0b9rYxbzZRr3nXjJ1NQ2
API reference	Full technical reference for Identomat’s REST API with request/response examples.	/pages/rA1jtXPZQc2eZi7l7nLP
SDKs	Mobile and web SDKs (iOS, Android, Flutter, React Native) with setup instructions and changelogs.	/pages/cPdm6wwmOslG4B8xBhkw

# Introduction Welcome to Identomat's documentation! *** Identomat is an ID verification & KYC/AML platform for a wide range of business needs, maximizing pass rates without compromising the accuracy, security, or compliance. Whether you're looking to prevent fraud, comply with regulatory requirements, or enhance the customer onboarding experience, our platform offers the tools and flexibility to meet your needs. ### Overview Identomat is designed to simplify the identity verification process through a combination of advanced technologies and a user-friendly interface. Our platform supports a wide range of verification methods, including:


Identity document verification	Automatically verify government-issued IDs, passports, and other documents. Identomat provides truly global coverage by recognizing thousands of ID types from over 165 countries.	/pages/0b9rYxbzZRr3nXjJ1NQ2#identity-document-verification
Liveness check	Verify the genuine presence of an identity holder with Liveness checks using selfie video with (Active) or without (Passive) prompts.	/pages/0b9rYxbzZRr3nXjJ1NQ2#liveness-check
AML monitoring	Screening and ongoing monitoring of customers against thousands of watchlists, sanctions and PEP lists, and adverse media lists.	/pages/rA1jtXPZQc2eZi7l7nLP#aml-screening
Address verification	Automated OCR and address validation for Proof of Address documents like bank statements, utility bills, etc., combined with location signals from IP & GPS.	/pages/0b9rYxbzZRr3nXjJ1NQ2#proof-of-address
Video KYC	Single or multi-participant live video call verification with built-in AI-powered full eKYC functionality for Human-in-the-Loop workflows.	/pages/qMezYAra47sEuMJsn6z8
KYC questionnaires	Configurable solution for capturing necessary information for Customer Due Diligence with custom form builder and answers-based logic.	/pages/0b9rYxbzZRr3nXjJ1NQ2#user-questionnaire
Phone and email verifications	Verify a prospective customer's email address and phone number via OTP, enriching their profile and adding a layer of account security.	/pages/0b9rYxbzZRr3nXjJ1NQ2#phone-number
No-code configuration builder	Seamlessly configure and deploy KYC workflows from ID capture and verification to Proof of Address and AML screening, to human-in-the-loop, and more.	/pages/Vh2KVAtSKWFjwhJLdTBn
Ease of integration & customizability	Our advanced identity verification platform offers configurable workflows, customizable UI/UX, and a modular architecture, with an option to fully white label the solution.

With our powerful API and SDKs, you can easily integrate our identity verification services into your existing systems and workflows. We also provide extensive customization options to tailor the verification process to your specific business requirements. ### **Key features of Identomat** Identomat's modular platform includes: * Comprehensive KYC/AML feature set * iBeta Level 2 certified Liveness Check * Rapid verification time * Global ID coverage * High conversion rate * Robust deployment options * White label solution


100 x	100x faster account activation compared to manual verification
40 sec	Avg. verification time
60%	Lower customer abandonment
165+	Countries & Territories
98%	Conversion rate

# Get started Create an account and learn how to use and integrate Identomat. ### Start using Identomat To get started with Identomat, create an account on [manage.identomat.com.](https://manage.identomat.com/) If you already have an account, you can proceed with integration.


Account setup	A detailed guide on how to set up your Identomat account.		/pages/26WGHzsWKaqgEjuFYHSI
Integration overview	Learn how to integrate Identomat with your system.		/pages/NCUj9lIsVP0ryHkK2NjU

# Account setup Create a personal account to get started with Identomat. ### About your personal account Personal accounts for Identomat are set up on [manage.identomat.com.](https://manage.identomat.com/) Through the management platform, you can access the dashboard, view detailed information on KYC (Know Your Customer) and KYB (Know Your Business) sessions, review applicants, create custom workflows, and retrieve your access key. To gain full access to all features on the Manage platform, your account must be verified by our team. ### Requesting an account If you don’t yet have an Identomat account, please [contact our team](https://www.identomat.com/contact-us) to request access. Our team will guide you through the onboarding process and provide credentials for the Manage platform. ### Sign in 1. Go to [manage.identomat.com](https://manage.identomat.com/) 2. Enter your email address and password, and click **Sign In**. > 💡 If your account needs activation and you've been waiting more than one day, please [contact us](https://www.identomat.com/contact-us). # User roles overview Learn about the different user roles in the Identomat system—Administrator, Operator, Call center operator, and End-user—and their specific access levels and functions to support various workflows. ### Roles in Manage platform Identomat offers three types of user roles in the Manage platform to accommodate various use cases and workflows: **Administrator**, **Operator**, and **Call center operator**. Users can hold multiple roles simultaneously if needed to fit their specific responsibilities. * **Administrator**: The highest level of access within the Manage platform. Administrators have full access to all dashboard features, can create configurations, manage users, delete sessions, and adjust company settings. If the company is registered as a Reseller, Administrators can also create and manage sub-company accounts. * **Operator**: The Operator role is tailored for agents and company representatives responsible for handling daily operational tasks. This includes reviewing and managing sessions, conducting live video verification calls, and overseeing routine verification processes. * **Call center operator**: A specialized sub-role of the Operator, focused on conducting manual verification during live video calls. Call center operators can only view sessions assigned to them. **Roles comparison table:**

Role	Permissions	Special abilities
Administrator	Full access	Manage users, settings, configurations, integration
Operator	Moderate access	Manage dashboard, verification sessions
Call center operator	Limited access	Receive user calls, manage own sessions

#### End-user * **End-user**: End-users are not Manage platform accounts. This term refers to individuals undergoing the verification process — they interact with the verification widget only, not the Manage platform. # Receiving calls Call center operators can receive end-user calls and conduct the video verification process. In Identomat's system, only users with the **Call center operator** role are responsible for receiving calls. When this role is enabled, a call toggle will appear at the top of the page. Activating this toggle allows the system to receive calls from end-users. When an end-user initiates a call, an incoming call animation will appear, and the Call center operator will hear a ringing sound. After answering, the operator connects with the end-user and can begin the verification steps configured for that session. If no Call Center Operator has the toggle active, incoming calls will not be received. Ensure at least one operator is available before end-users begin sessions with a video call step. **Call center operators** may: * Take live screenshots of the end-user. * Fill out operator questionnaires during the session. * Initiate KYC steps for the end-user. For more details, see:


Video KYC	Learn how live video verification works, including the full operator and end-user flow, call controls, and compliance features.		/pages/bmez9GTbL908eOVutwYc

# Integration overview Whether you're looking for a lightweight, front-end solution or a more comprehensive server-side integration, we've got you covered. ### Available integration options Identomat can be integrated into your systems in several ways, depending on your technical requirements and use case. Choose the option that best fits your setup:


No-code integration	Customize your verification flow and send verification links to end-users directly from the Manage platform — no development work required.	/pages/XhW0Q99c8xPjlnDizbRR
Identomat SDKs	Native SDKs for iOS, Android, Flutter, and React Native. Covers setup, configuration, and key functionalities for seamless in-app identity verification.	/pages/pNF9o4WdcSzYieGqk7Ld
Identomat API	A REST API for full control over session creation, configuration, and result retrieval. Ideal for custom integrations and server-side workflows.	/pages/rA1jtXPZQc2eZi7l7nLP

Not sure which to use? Start with the **No-code integration** if you want to get up and running quickly. Choose the **API** or **SDKs** if you need to embed verification directly into your product. # API access To begin integrating with Identomat, you’ll need API keys to authenticate requests ### Obtaining API keys * **Navigate to the API keys section**: Log into your Identomat dashboard and select **API keys** from the menu**,** nested under **Settings** . * **Generate key**: In the API section, click the **Generate key** button. * **Whitelist IPs (optional):** You can restrict a key to a set of specific IP addresses, so that only requests from those IPs are accepted — requests from any other IP will be rejected. If no IPs are added, the key will accept requests from any IP. Whitelisted IPs aren't locked in at generation — you can add or remove them at any time from the key's settings. * :exclamation: **Store securely**: Copy the generated API key and securely store it. For security purposes, the key will only be displayed once. If lost, you’ll need to generate a new one. > 💡 **HMAC authorization**: For enhanced security, you can implement HMAC authorization using your secret key as the encryption key. This is optional but recommended for production environments. ### Procedure The integration procedure consists of the following steps: 1. **Acquiring a `session_token`.** 2. **Redirecting the user's browser to widget.identomat.com.** 3. **Checking for a result.** To acquire a `session_token`, the company server needs to call the **/begin** endpoint and provide the following arguments: `company_key`, `flags` and `steps`. The steps array contains the configuration for individual steps in the identification process, each of which can have its own set of flags specific to that step. **The endpoint used to create a session\_token:** ``` https://widget.identomat.com/begin/ ``` For more details, see:


Developer guide	Step-by-step instructions and best practices for integrating and customizing our identity verification solutions.		/pages/0b9rYxbzZRr3nXjJ1NQ2
API Reference	Comprehensive details on endpoints, parameters, and response formats for seamless API integration.		/pages/rA1jtXPZQc2eZi7l7nLP

# Overview No-code configurations allow you to create and customize identity verification workflows without writing any code. Use the intuitive interface to define steps that align with your business needs. ## Introduction No-code configurations enable you to create and customize identity verification workflows **without writing a single line of code.** This feature provides a user-friendly interface where you can define steps, set parameters, and automate verification processes to meet your business requirements. Whether you're adjusting verification rules, adding extra security measures, or streamlining user onboarding, no-code configurations give you full control—without the need for development resources. ## **Key benefits** 1. **Ease of use** - A drag-and-drop or form-based interface allows anyone to configure workflows without technical expertise. 2. **Flexibility** – Customize workflows to fit different verification needs, such as KYC, AML screening, document validation or Proof of Address analysis. 3. **Faster deployment** – Make changes in real time without waiting for developers, ensuring quicker adaptation to regulatory or business needs. 4. **Scalability** – Easily modify and expand workflows as your company grows and verification requirements evolve. ## **How It Works** Setting up a no-code Configuration involves a few straightforward steps: 1. **Access the no-code configurations** – Navigate to the Configurations section in your dashboard and create a new one. 2. **Define workflow steps** – Select from available verification steps such as **ID verification, Liveness, or Video KYC** to build your workflow. 3. **Set parameters** – Configure individual steps and overall workflow rules, such as redirecting users after verification is completed. 4. **Test and deploy** – Preview your workflow, make adjustments, and activate it by creating a new session or using the Configuration ID or Public URL. ## **Use cases** No-code configurations can be applied in various scenarios, including: * **Financial services** – Set up automated KYC workflows for new account openings. * **E-commerce & Marketplaces** – Verify sellers and buyers before allowing transactions. * **Gig economy & Hiring platforms** – Conduct identity and background verification for freelancers or employees. * **Cryptocurrency & Fintech** – Implement compliance-driven checks for AML and fraud prevention. * **Healthcare & Insurance** – Authenticate users before granting access to sensitive medical or policy data. # Getting started Prerequisites to create no-code configurations. To start using No-code configurations, follow these steps to ensure a smooth setup and deployment: ### Ensure you have the right permissions Before using No-code configurations, make sure you have the necessary access: * This feature is **only available for the Administrator role**. (Refer to the [**User roles overview**](/get-started/user-roles-overview) for more details.) * If you don’t have the required permissions, contact your system administrator or reach out to our support team for assistance. * If you are an **Administrator** but the **`+ New configuration`** button is unavailable, your account may be on a **trial plan**. In this case, please contact us to enable full access. ### Navigate to the configurations section * **Log in** to your dashboard and go to **Settings** in the navigation menu. Locate and click on the **Configurations** section. * Click on **`+ New configuration`** to start building your workflow. * If this is your first time using the feature, review the interface and available options. You can create **unlimited configurations**—this feature is **free to use on all paid plans**. ### Choose a verification type Before selecting individual steps, choose the **verification type** for your workflow: * **KYC (Know Your Customer)** – Designed for verifying individual users. Supports personal identity documents, liveness checks, video calls, and other individual-focused verification steps. * **KYB (Know Your Business)** – Designed for verifying legal entities and organizations. Enables business document verification and related checks specific to companies and their representatives. The selected verification type determines which steps are available in the workflow. ### **Review available verification steps** Explore the verification steps available for your workflow, including: * **ID verification** – Users submit identification documents for validation. * **Liveness check** – Ensures the user is present and real during verification. * **Video call** – Conducts live video-based verification sessions. * **Proof of Address** – Includes verification of proof of address and analysis of other document types. ### **Create your first configuration** * Finalize your flow by **dragging and dropping** or **selecting** the necessary verification steps. * Define key settings to match your verification requirements, such as: * **Required document types** (e.g., passport, ID card, driver’s license) * **Liveness retry limits** to control the number of user attempts * **Redirect URLs** after successful or failed verification * **Allowed document countries** to specify accepted regions * Once all settings are in place, **save your configuration** to make it available for use. ### **Test before going live** * Run sample test sessions from the dashboard to validate the workflow's behavior. You can create a test session by selecting your configuration and clicking **Generate link**. * Check for: * Proper step execution and flow * Accurate verification results * Expected redirections and notifications * Make necessary adjustments based on test results. ### **Deploy and monitor** * Once your configuration is finalized, deploy it by: * **Creating a new session** from the dashboard * Using the **Configuration ID** in API requests * *Your* *Configuration ID is available on the configuration detail page.* * Sharing the **Public URL** for end-user access * Once deployed, monitor verification results and session statuses from the **Dashboard**. # Localization Translate questionnaires, step titles, descriptions, and other UI texts directly within the Configuration builder so end-users see the verification widget in their preferred language. ### How localization works **Prerequisite: the Language step** * **Purpose**: Localization only becomes available once a **Language step** is added to your configuration. This step defines which additional languages users can choose from during verification. * **Tip**: Add the Language step first, then come back to translate your content — if no Language step exists, the builder behaves as single-language and the language selector won't appear. ### **The language selector** * **Purpose**: Once a Language step exists, a selector appears at the bottom of the Configuration builder, letting you choose which language you're currently editing content for. * **How it works**: * The selector is visible at all times, no matter which step or section you're working on * Your **default language** (set in Configuration settings) is always listed first and pre-selected * All other languages you've added via the Language step appear below it * Use the search field to quickly find a language in a long list * Click **Add more** to jump to the Language step and add or remove available languages * **Tip**: Think of the selector as a *"which language am I typing in right now"* switch — it applies to every translatable field in the builder: step titles, descriptions, questionnaire titles, questions, options, and prefilled answers. *** ### Editing modes **Default language — full editing** When the default language is selected, you have full control over your configuration: * Add or remove questions and options * Edit structure and keys, adjust step parameters. * Edit all titles, labels, and descriptions This is your "source of truth" — all translations reference back to whatever is written here. **Translation language — translation-only mode** * **Purpose**: When you switch to any non-default language, the builder enters a restricted **translation-only mode**, so you can safely add wording without accidentally changing the structure of your flow. * **What happens**: * Every text field shows your default-language text as a **placeholder**, so you always have the original to translate from * Structural editing is disabled — you can only edit text, not add, remove, or reorder anything * **Tip**: If you need to restructure anything (add a question, remove an option, etc.), switch back to the default language first — translation mode is purely for wording. **If your configuration has errors** * If you try to enter translation mode while your configuration has unresolved errors, you'll see a **"Fix errors before translating"** prompt asking you to resolve them first. * **Tip**: Resolve validation errors in the default language before starting translation work, to avoid this interruption. *** #### Saving translations * There's no separate "Done" button for translations — everything is saved using the main **Save** button, just like your default-language content. * You can translate as much or as little as you like: * Only languages you've actually edited are stored * Only fields you've actually translated contain that language's text * Partial translations are completely fine — nothing needs to be "complete" before saving *** #### How the widget displays translations * **Purpose**: Controls what an end-user sees when they use the verification widget in their selected language. * **How it works**: * If a translation exists for the user's language, it's shown * If a translation is missing for a specific field, the widget automatically falls back to the default language for that field only * Partial translations never cause errors — users simply see a mix of translated and default-language text where needed **Changing your default language later** If you change the default language after content already exists, the system automatically remaps your existing content to the new default language key — and never overwrites content that already exists under that key. This makes it safe to change your default language without losing translated work. # Configuration settings Understanding configuration settings on the first tab of no-code builder The first tab of the No-Code Builder is where you will find essential settings to customize and configure your workflow. ## Configuration settings The **Configuration settings** section includes key configurations related to the identification and organization of your workflows. Here’s an overview of the settings you’ll encounter: ### Configuration name * **Purpose**: The name assigned to the configuration to easily identify it in your dashboard. It must be unique across your company, but it can be changed at any time. * **Tip**: Choose a descriptive name that reflects the purpose or specific use of the configuration (e.g., "Standard ID verification flow" or "KYC onboarding"). This makes it easier to locate and manage workflows. ### Configuration ID * **Purpose**: A unique identifier automatically generated when you create a configuration. This ID is used to reference the configuration in API requests, ensuring that the correct workflow is applied during user verification. * **Tip**: Use the Configuration ID in API calls or when linking the configuration to external systems. Keep it handy for integration purposes. ### Public URL * **Purpose**: The Public URL provides external access to your verification flow. Share it with users to direct them to the verification process — via invitation emails, embedded links, or other channels. * **How it works**: Each Public URL contains a unique `public_config_id` parameter that identifies your verification flow: ``` https://widget.identomat.com/launch/?public_config_id= ``` When a user opens this URL, the platform automatically creates a new session and redirects them to a unique session URL: ``` https://widget.identomat.com/?session_token= ``` The `public_config_id` stays the same for all users — a fresh `session_token` is generated for each individual session. * **Activation**: The Public URL is **disabled by default**. You will need to **enable** it before you can copy and share the link. * **Temporarily disabling**: Turning off the Public URL disables access without permanently removing it. You can re-enable it at any time. * **Refreshing the URL**: Use the **`Refresh`** button to permanently replace the current Public URL with a new one. This generates a new `public_config_id`, invalidating the previous URL — anyone using the old link will no longer be able to access the flow. **This action cannot be undone.** * **Tip**: Only share the Public URL with trusted parties. If access needs to be paused temporarily, disable the URL rather than refreshing it, so you can restore it later. ### Default language * **Purpose**: Set the default language for the verification flow. This defines the language in which the verification steps, instructions, and notifications will be displayed to the user. * **Tip**: Choose the language that best matches the primary user base for this workflow. If you're unsure of the user's preferred language in advance, you can configure a **Language step** in the **Steps tab**. * In this case, the **default language** you select here will be pre-selected for the user when they first encounter the language selection step. However, users will still have the option to change it if they prefer a different language. ### Groups with access * **Purpose:** Define which user groups within your company are allowed to use this configuration. This setting controls visibility and access at the group level. \ If you select one or more groups, *only* members of those groups will be able to see and use the configuration in their dashboard.\ If you do **not** select any groups, the configuration becomes visible and accessible to **everyone** in the company. * **How it works:** This field is presented as a **multi-choice dropdown** listing all groups available within the company. You may select one or many, depending on how you want to restrict access. * **Tip:** Use this option to manage access for different teams, such as separating internal testing flows, production workflows, or department-specific configurations (e.g., “Fraud team”, “Support team”, “KYC operations”). Keeping access limited helps avoid accidental changes or unauthorized usage. *** ## Session settings The **Session Settings** section allows you to customize various aspects of the verification session process, controlling how long sessions last, how they can be accessed, and specific verification rules. Here's an overview of the settings you'll encounter: ### Session lifetime (minutes) * **Purpose**: Defines the maximum duration (in minutes) that a verification session will remain active. After this time, the session will expire, and the user will need to restart the verification process. * **Tip**: Specify the session lifetime in minutes based on your security requirements. For example, you might set it to 15 minutes for a quick verification or longer for more detailed processes. ### Schedule session * **Purpose**: When the **Schedule Session** toggle is enabled, it allows you to schedule a verification session to take place at a specific date and time in the future. This is especially useful for setting up verification flows in advance, giving users the option to book their session for a later time rather than initiating it immediately. * **Tip**: Enable this toggle if you want users to have the flexibility to book their verification session in advance. User-side booking will be handled on your platform, while the session itself can be scheduled on our platform for a designated date and time. This ensures that verification sessions are managed according to your desired timeline and user convenience. ### **Request additional information** * **Purpose**: When enabled, allows operators to request further verification from an applicant after a session has already reached a terminal state (approved, rejected, manual check, or expired), without creating a new session. All verification attempts remain stored under the same session, preserving a complete audit trail. * **Tip**: Enable this setting for workflows where re-verification may be required — for example, when additional documents are needed or a previous submission was incomplete. * **Default**: Disabled by default. Once enabled, operators will see the **Request more information** button on eligible sessions in Manage. ### Force user to continue on mobile device * **Purpose**: When enabled, this setting forces the user to complete the verification process on a mobile device. The session will display a **QR code** at the beginning, which the user can scan to continue the verification on their mobile device. This ensures that the entire verification process occurs on mobile, which is essential for processes that require mobile-specific features. * **Tip**: Enable this toggle if your verification process is designed to be mobile-first or requires mobile-specific features. ### Allow user to continue on another device * **Purpose**: When enabled, this option allows users to resume their verification process on a different device. This is useful in cases where users start the verification on one device but need to switch to another (e.g., moving from desktop to mobile). * **Tip**: Enable this toggle to provide flexibility for users who may need to switch devices without losing progress. ### Restrict URL sharing * **Purpose**: When enabled, this setting prevents users from sharing the session URL with others. It ensures that only authorized users can access the verification flow and adds an extra layer of security. * **Tip**: Use this option if the verification flow contains sensitive or high-security processes that should not be accessible to unintended users. ### Require FHD camera * **Purpose**: When enabled, this setting ensures that users complete all **camera-based steps**—such as **liveness checks**, **document capture**, or **selfies**—using a **Full HD (FHD)** camera. This helps maintain high-quality image input, which is crucial for accurate identity verification and fraud detection. * **Tip**: Enable this option if your process requires **clear, high-resolution visuals** to meet compliance or technical accuracy standards. If the user’s device does not meet the FHD requirement, they may be prompted to switch devices or will not be able to proceed. ### Screening * **Purpose**: Enables or disables screening as part of the verification process. Screening typically involves checking the user’s data against external datasets (e.g., watchlists, sanctions lists) to ensure compliance. * **Tip**: Enable this toggle if screening is part of your verification process and you want to ensure users are checked against specific datasets. * **Activation:** Screening is available only in paid plans. If you are on a trial plan, it may not function properly. For full access to screening features, you will need to contact our support team to ensure the right permissions are in place. * **Minimum screening score** * **Purpose**: The Minimum screening score allows you to set a threshold score that the user must meet in order to pass the screening phase. If the user's screening score falls above this threshold, they will be rejected. This feature helps ensure that only users who meet the required compliance standards proceed in the verification process. * **Tip**: Set this score based on your risk management strategy or compliance standards. For example, if your compliance policy requires a strong match with screening data, you might set the threshold to **85%** pass rate. * **Screening datasets** * **Purpose**: The Screening datasets option lets you select which external datasets to use during the verification process. These datasets help verify the user's identity by comparing their data against various lists. * **Datasets include**: * **Default** * **UN Sanctions** * **Georgian Sanctions** * **Adverse Media** * **Tip**: Choose the relevant datasets based on your industry, regulatory requirements, or business needs. For example, if your organization operates internationally, you may need to use global sanctions lists, while a local business might focus more on national or regional databases. * **When to run screening** * **Purpose:** Defines **at which stage of the verification flow screening is executed**. This setting controls whether screening applies only to approved sessions or to all completed sessions, including rejected ones. * **Options:** * **After session approval:** Screening runs **only for sessions that have been approved**.\ Rejected sessions are not screened. * **After session completion:** Screening runs for **all completed sessions**, regardless of whether the session was approved or rejected. * **Tip:** Use **After session approval** if you want to minimize screening volume and cost by screening only successful verifications.\ Use **After session completion** if your compliance policy requires screening all users who reach the end of the verification flow, including rejected cases. ### VPN detection * **Purpose**: Detects whether an applicant is connected via a VPN during their verification session. When enabled, you can define how the session should respond if a VPN connection is identified, allowing you to enforce stricter access controls or flag suspicious activity. * **Tip:** Enable this toggle if your compliance policy or risk management strategy requires monitoring for VPN usage. > ⚠️ VPN detection is a paid add-on. Contact our team to enable it for your account. **If VPN is detected** * **Purpose:** Defines the action taken when a VPN connection is detected during a session. This setting appears when VPN detection is enabled. \ Options: * **Do nothing:** The session continues as normal. VPN usage is noted but does not affect the outcome. * **Reject session:** The session is automatically rejected at the end if a VPN was detected. * **Flag for manual check:** The session is flagged for manual review at the end, allowing an operator to make the final decision on approval or rejection. * **Tip:** Choose the action that aligns with your risk tolerance. Use **Reject session** for high-security flows where VPN usage is not acceptable. Use **Flag for manual check** if you prefer human oversight before making a final decision. *** ## Other settings The **Other Settings** section includes additional configuration options to enhance the verification process. Here’s an overview of the settings you’ll find: ### Return URL * **Purpose**: The Return URL is a custom URL that users are redirected to after completing the verification process. It can be used to direct users to a specific page or action, such as a confirmation page, dashboard, or any other location relevant to your workflow. * **Tip**: Define a Return URL to ensure users are redirected seamlessly after the verification process. This is especially useful if you need users to land on a post-verification page (e.g., a success page or next-step instructions). ### Pass custom QR URL * **Purpose**: If you're using the **Force user to continue on mobile device** feature, you can provide a custom **QR URL**. This allows you to pass a unique URL within the QR code that users scan to continue the verification process on their mobile devices. * **Tip**: Enable this option if you want the QR code to link to a specific URL. This can be used for special workflows or user-specific data. ### Enable SMS notifications * **Purpose**: This option allows you to send **SMS notifications** to users, which can include **One-Time Passwords (OTP)** or other critical updates related to the verification process. SMS notifications are helpful for user authentication, reminders, and alerts. * **Tip**: Enable **SMS notifications** if your verification process requires real-time communication with users, such as for sending OTPs or session reminders. Make sure to collect user phone numbers as part of the workflow to utilize this feature effectively. ### Recurring face recognition * **Purpose**: Recurring face recognition utilizes a face database to store facial data from users for future verification sessions. This enhances fraud detection by grouping sessions under a **personas** feature, allowing you to track users across multiple verification attempts. * **Tip**: Enable this feature if you need to track users over time and improve security by detecting repeat users and identifying potential fraud. It is particularly useful for KYC, AML, and other compliance-related processes where recognizing the same user across sessions is crucial. # KYC steps Understanding steps for KYC configuration on the second tab of no-code builder The Configuration steps tab allows you to design and customize your verification workflow by adding, organizing, and configuring different steps. This tab consists of three main sections: ## Overview 1. **Available steps (Left panel)** * This section contains all the verification steps that you can include in your workflow. * Steps may include Language, ID verification, Liveness check, Selfie with ID, Proof of Address, Video call, User questionnaire, Operator questionnaire, Phone number, Email, Geolocation. * **Click the steps** in the left section to add them to your workflow. 2. **Steps builder (Middle panel)** * Displays the **current steps** in your verification flow. * You can **rearrange** steps by dragging and dropping them to change the execution order. * Unwanted steps can be **deleted** if they are no longer needed. 3. **Step settings (Right panel)** * When a step is selected, its parameters appear in this panel. * You can **adjust parameters** such as retry limits, document type selection. * Advanced settings (e.g., step keys) can also be managed here. ## Step settings The Step settings panel allows you to fine-tune each verification step by adjusting its specific parameters based on your business and compliance needs. When a step is selected, this panel provides configuration options. **Step titles appear in two places:** on the progress indicator shown to users resuming the flow on mobile or desktop, and in the video call operator's frame, where they're used to manually trigger steps. ### **Step titles** * **Purpose**: Step titles are used for display purposes in various contexts: * When a user switches to a mobile device, the desktop screen displays the current step they are on. * In a **video call verification**, the operator sees the step titles inside their interface to manually trigger or monitor the verification process. * **Tip**: Choose clear and descriptive step titles to improve the user experience and help operators navigate the process efficiently. ### Advanced tab The **Advanced** tab stores all the necessary keys for steps, questions, and answers to facilitate integrations with external systems. These keys can be used for API integrations or other external applications that interact with the verification flow. **Purpose** * **Step keys** – Unique identifiers for each verification step. * **Question keys** – Identifiers for the specific questions in forms or questionnaires. * **Answer keys** – Corresponding keys for answers provided by users in questionnaire steps. These keys enable seamless integration with other systems and facilitate tracking and reporting of data. *** ## Steps ### Language * **Purpose**: The Language step allows users to select their preferred interface language from a dropdown list before proceeding with verification. * **Positioning**: This step is **always positioned first** in the workflow. * **Step Parameters**: * Define the list of **available languages** that users can choose from. * You must select at least **two languages** to enable the dropdown selection. * **Tip**: If your users primarily speak a specific language, consider setting a **default language** in the general settings, while still offering alternative options for accessibility. *** ### ID verification **Purpose**: The ID verification step is responsible for verifying a user’s primary identity documents. This step includes multiple configuration options to ensure document authenticity and compliance with verification requirements. #### **Document type** Defines which types of identity documents the user can select for verification. Options include: * ID card * Passport * Residence permit * Driver’s license #### **Method** Determines how users can submit their identity document: * **Capture** – The user must take a live photo of the document. * **Upload** – The user can upload an existing image of the document. * **Both** – The user can choose either option. #### Other parameters **Compare document fields** * Compares textual information between the document’s **Visual Zone (VIZ)** and **Machine-Readable Zone (MRZ)**. * Prevents users from passing verification if the fields do not match. **Compare document pages** * Ensures the **front and back pages** belong to the same document. * If discrepancies are found, the session is **rejected.** **Block expired documents** * Rejects users if the expiration date has **already passed**. **Spoofing detection** * Detects attempts to use **fake or altered** identity documents and **rejects** such sessions. **Grayscale detection** * Identifies if the document is **grayscale** (black & white) and **rejects** it to ensure authenticity. **Visual damage detection** * Scans the document for **physical defects**, such as a damaged chip. **Warn if document expires within (days)** * Sends a **warning** if the document will expire within the specified number of days. **Reject if document expires within (days)** * **Rejects** the session if the document is set to expire within the specified timeframe. **Block person under age (years)** * Rejects users **below** the specified age limit. **Allowed document countries** * Restricts document verification to **specific countries**. * Prevents users from verifying if the document is from an unlisted country. #### Document data review **Enable document data editing** * When enabled, a review page is shown to the applicant/operator after document scanning, allowing them to verify and correct OCR-extracted data before proceeding. * Disabled by default. **Who can edit** * Defines which parties are allowed to edit document fields. Options: * **User only** – Only the applicant can make corrections. * **Operator only** – Only the operator can make corrections in Manage. * **Both** – Both the applicant and operator can make corrections. **Editable fields** * Defines which document fields are available for correction. For each field you can set: * **Mandatory** – Whether the field must be filled before the applicant can proceed. For the full list of configurable fields and behavior details, see [Document data review ](/platform-concepts/document-data-review)in Platform concepts. For API-level configuration of this feature, see [Document data review configuration](/developer-tools/developer-guide/kyc-know-your-customer#identity-document-verification) in the Developer guide. *** ### Liveness check **Purpose:** The Liveness check step ensures that the user is a real, live person and not a spoofed or manipulated image. During this step, the user positions their face within the designated frame and follows the instructions. Identomat offers two types of liveness checks: #### **Liveness type: Active liveness** * An **advanced biometric check** where the user is prompted to perform specific actions (e.g., blinking, turning their head) to confirm their presence as a real person. * Designed to prevent **spoofing attempts** using photos, videos, or masks. #### **Liveness type: Passive liveness** * A **basic liveness check** where the user simply holds their head within an oval frame. * The system captures a **two-second video** to analyze and confirm liveness. #### **Method for passive liveness** Defines how the liveness check is performed: * **Capture** – The user must take a live video using their device’s camera. * **Upload** – The user can upload a selfie. * **Both** - The user can choose either option. #### **Maximum attempts for liveness** * Specifies the **maximum number of attempts** allowed for the user to complete the liveness check. * If the user exceeds this limit, the session is **rejected**, and they must restart the process. *** ### Selfie with ID **Purpose:** The Selfie with ID step ensures that the user is physically present with their identity document. Users must hold their document in their hands so that both their **face and the document** are clearly visible in the captured image. #### **Method** Defines how the user submits their selfie with the document: * **Capture** – The user must take a live photo using their device’s camera. * **Upload** – The user can upload an existing image where they are holding their document. * **Both** – The user can choose either option. *** ### **Proof of Address** **Purpose:** The Proof of Address step verifies a user’s residential address by analyzing official documents that contain their name and address. #### **Document type** Users can upload one of the following accepted documents as Proof of Address: * Bank statement * Utility bill * Driver’s license * Vehicle registration certificate * Yellow Slip *** ### Video call **Purpose:** The Video call step connects the user with an operator for **manual identity verification**. The operator can interact with the user in real-time and initiate other verification steps as needed. Identomat supports two types of video calls: * **One-on-one call** – A secure direct video call between a customer and a verification operator. * **Multi-user call** – Allows **multiple participants** in a single session, where each user follows their own customized verification workflow. #### **`+ New step` button** Adds verification steps within the video call process, allowing the operator to trigger them manually. **Call type** * **Single participant** – A one-on-one video call. * **Multiple participants** – A multi-user video call. **Participant name** * If enabled, the **user must enter their name** before joining the call. **Force user's camera on** * If enabled, the **user cannot turn off their camera** during the call. **Reset verification** * If a user **disconnects and rejoins**, all previous verification data is cleared for security reasons, and the operator must restart the process. *** ### User questionnaire **Purpose:** The User questionnaire step is designed to collect structured user input through various form types. The provided information is securely stored within the verification session. Questionnaire steps offer a wide range of configurable question formats. #### Questionnaire details * **Title** – The main title of the questionnaire. * **Description** – A brief text displayed below the title to provide context. * **Success button title** – Customizable text for the confirmation button. #### Questions and answers Identomat supports a variety of question types, all of which offer customizable parameters: #### Short answer Users can type in a response to an open-ended question. * **Question title** – The label for the question. * **Answer format** - Defines the expected structure of the user’s response. This setting controls how the input is validated and which type of data the system accepts. * **Free text** - Users can enter any text without restrictions. * **Email -** Users must enter a valid email address; the system enforces email format validation. * **Prefilled answer** – A prefilled answer that the user can edit. * **Required** – Determines whether the question must be answered. * **Read-only mode** – Prevents users from editing the default answer. * **Condition** – The question only appears if a specified condition is met. #### Checkbox (Multiple selection) Users can select one or more predefined options. * **Question title** – The label for the question. * **Default answer** – Pre-checked options that users can modify. * **Required** – Determines if at least one option must be selected. * **Read-only mode** – Prevents users from modifying selections. * **Condition** – The question only appears if a specified condition is met. * **`+ Add option`** – Define multiple selectable choices. #### Radio (Single selection) Users can select only one option from a predefined list. * **Question title** – The label for the question. * **Default answer** – Preselected option that users can change. * **Required** – Determines if a selection is mandatory. * **Read-only mode** – Prevents users from modifying selections. * **Condition** – The question only appears if a specified condition is met. * **`+ Add option`** – Define the available choices. #### **File upload** Users can upload files, such as images or PDFs. * **Question title** – The label for the question. * **Description** – Additional instructions displayed under the title. * **Maximum number of files** – Limit the number of files users can upload (max: 10). * **File types** – Restrict uploads to **PDFs**, **images**, or both. * **Required** – Determines if file upload is mandatory. * **Condition** – The question only appears if a specified condition is met. #### **Dropdown** Allows users to select one or multiple values from a predefined dropdown list. * **Question title** – The label for the question. * **Dropdown options** – Define the dropdown list by providing options in a comma-separated format (e.g., *Option 1, Option 2, Option 3*). * **Multi-select** – If enabled, users can select multiple options from the dropdown list. If disabled, users can select only one option. * **Required** – Determines if a selection is mandatory. * **Error message** – The message displayed if the field is required but no selection is made. * **Condition** – The question only appears if a specified condition is met. #### **Attachment** Allows users to access files that are either uploaded by operators during the session or pre-attached by administrators via the no-code builder or API. * **Title** – The label for the question. * **Description** – Additional instructions displayed under the title. * **File attachment mode (Radio)** – Define how files are provided to the user: * **Uploaded by operator per session** – Operators can upload files during the session that are visible to the user. * **Allow changes to attachments after user confirmation -** If toggle is **turned off,** the operator cannot edit attachments after the user **confirms** the questionnaire. If **enabled**, the operator may still upload or remove files. * **Pre-attached file** – Files uploaded in advance via the no-code configurations or API. * **Maximum number of files** – Limit the number of files users can upload (max: 10). * **File types (Checkbox)** – Restrict uploads to **PDFs**, **images**, or both. * **Condition** – The attachment field only appears if a specified condition is met. *** ### Operator questionnaire The operator questionnaire appears in the session, and the operator can fill out the form during or after the session. #### Questionnaire details * **Title** – The main title of the questionnaire. * **Description** – A brief text displayed below the title to provide context. #### Questions and answers Identomat supports **five types of questions**, each with customizable parameters: #### Short answer Operators can type in a response to an open-ended question. * **Question title** – The label for the question. * **Answer format** - Defines the expected structure of the operator's response. This setting controls how the input is validated and which type of data the system accepts. * **Free text** - Operators can enter any text without restrictions. * **Email -** Operators must enter a valid email address; the system enforces email format validation. * **Prefilled answer** – A prefilled answer that the operator can edit. * **Required** – Determines whether the question must be answered. * **Read-only mode** – Prevents operators from editing the default answer. * **Condition** – The question only appears if a specified condition is met. #### Checkbox (Multiple selection) Operators can select one or more predefined options. * **Question title** – The label for the question. * **Default answer** – Pre-checked options that operators can modify. * **Required** – Determines if at least one option must be selected. * **Read-only mode** – Prevents operators from modifying selections. * **Condition** – The question only appears if a specified condition is met. * **`+ Add option`** – Define multiple selectable choices. #### Radio (Single selection) Operators can select only one option from a predefined list. * **Question title** – The label for the question. * **Default answer** – Preselected option that operators can change. * **Required** – Determines if a selection is mandatory. * **Read-only mode** – Prevents operators from modifying selections. * **Condition** – The question only appears if a specified condition is met. * **`+ Add option`** – Define the available choices. #### **File upload** Operators can upload files, such as images or PDFs, directly into the session while filling out the questionnaire. These files become part of the session record and can later be reviewed by administrators or other authorized roles. * **Question title** – The label for the upload field. * **Description** – Additional instructions displayed under the title. * **Maximum number of files** – Limit the number of files operators can upload (max: 10). * **File types** – Restrict uploads to **PDFs**, **images**, or both. * **Required** – Determines if file upload is mandatory for the operator before submitting the questionnaire. * **Condition** – The upload field only appears if a specified condition is met. #### **Dropdown** Allows operators to select one or multiple values from a predefined dropdown list while filling out the session questionnaire. * **Question title** – The label for the dropdown field. * **Dropdown options** – Define the list of options by providing values in a comma-separated format (e.g., *Option 1, Option 2, Option 3*). * **Multi-select** – If enabled, operators can select multiple options. If disabled, only one option can be selected. * **Required** – Determines if a selection is mandatory before submitting the questionnaire. * **Condition** – The dropdown field only appears if a specified condition is met. *** ### Phone number Purpose: The Phone number step allows for the collection or verification of a user’s phone number. The provided phone number is stored within the session. **Method** * **Collect** – The user enters their phone number, and it is stored in the session without verification. * **Verify** – The user enters their phone number, and an **OTP (One-Time Password)** is sent. The phone number is stored only after the OTP is successfully verified. *** ### Email **Purpose:** The Email step allows for the collection or verification of a user’s email address. The provided email is stored within the session. **Method** * **Collect** – The user enters their email address, and it is stored in the session without verification. * **Verify** – The user enters their email address, and a **confirmation code** is sent. The email is stored only after the verification code is successfully confirmed. *** ### Geolocation **Purpose:** The Geolocation step collects and verifies the user’s physical location during the verification process. This helps ensure compliance with jurisdiction, AML, or KYC requirements. *** ### **SSN verification** **Purpose:** The SSN verification step verifies a user's **Social Security Number** as part of the identification process. *** ### AnyDoc reader **Purpose:** The AnyDoc step lets you **extract structured data from any document type** using AI - such as payslips, bank statements, utility bills, or tax certificates. You define the fields you want extracted, and the system reads, validates, and flags the data automatically. Unlike Proof of Address, which supports a fixed set of predefined document types, AnyDoc is fully configurable per document, making it suitable for client-specific or non-standard document types. #### **Step parameters** **Document type** * Free-text label identifying the document being requested (e.g. "Payslip", "Bank Statement", "Tax Declaration"). * Displayed across session details and API output. * **Required.** **Allowed formats** * Restricts uploads to **PDF**, **Image**, or both. * At least one must be selected. **Page configuration** * Defines whether the document is expected to be **single page** or **multiple pages**. * If **Multiple pages** is selected, you may optionally specify the exact number of pages expected. If left blank, all uploaded pages are processed regardless of length. Maximum number of pages defaults to **10.** **Extraction hint** * Optional free-text context about the document as a whole, given to the AI to improve extraction accuracy (e.g. layout quirks, formatting conventions). * Recommended to write in English for best accuracy, regardless of the document's actual language. **Document validity check** * When enabled, rejects or flags documents older than a configured age, based on a date extracted from the document. * Requires selecting a **Date field** (must be a field of type Date, configured below) and a **Maximum document age** (a number plus a unit: Days, Weeks, Months, or Years). **Document language** * Optional. Specifies the expected language of the document to guide extraction. * If left blank, the language is detected automatically. * Used only to inform the AI - never shown to the end user. **Confidence threshold** * A score from 0–100 below which an extracted field is flagged for manual review. * Applies to all fields by default (80), but can be overridden per field. **Retry limit** * Maximum number of times a user can re-upload or recapture a document in this step. * Each attempt uses one AI processing credit, so this is configurable per step to control usage. #### **Field configuration** Each document type can have one or more fields defined for extraction. For every field, you can configure: **Field type** * Determines how the extracted value is validated and formatted. * Options: Text, Number, Date, Yes/No, Email, Phone number, Currency, Money/Amount, Tax ID/Registration number, Address, Percentage, Other. * If **Other** is selected, you can optionally specify what kind of data the field contains — if left blank, it's treated as free text with no specific validation. **Field label** * The name of the field, used to help the AI identify it in the document and shown during review. * Optional if an Extraction hint is provided instead. **Alternative names** * Optional comma-separated list of other terms this field may appear as in the document (e.g. "Sex, Male/Female" for a Gender field). * Used only to improve extraction accuracy - not shown anywhere in review or output. **Field key** * A unique identifier used to reference this field in API output. * Required, and must be unique within the step. **Extraction hint** * Optional guidance telling the AI how to find and interpret this specific field. * Recommended to write in English for best accuracy, regardless of the document's language. * At least one of Field label or Extraction hint must be provided per field. **Confidence threshold override** * Optional. Overrides the step-level confidence threshold for this specific field only. **Required** * Toggle. If enabled, the session is flagged when this field cannot be extracted from the document. *** # KYB steps Understanding steps for KYB configuration on the second tab of no-code builder The KYB configuration steps tab allows you to design and customize your KYB workflow by adding, organizing, and configuring different steps. This tab consists of three main sections: ## Overview * **Available steps (Left panel)** * This section contains all the verification steps that you can include in your workflow. * Steps may include Language, User questionnaire, Company data and Beneficiaries. * **Click the steps** in the left section to configure the KYB process. 2. **Steps builder (Middle panel)** * Displays the **current steps** in your verification flow. * You can **rearrange** steps by dragging and dropping them to change the execution order. * Unwanted steps can be **deleted** if they are no longer needed. 3. **Step settings (Right panel)** * When a step is selected, its parameters appear in this panel. * You can **adjust parameters** such as company data fields selection. * Advanced settings (e.g., step keys) can also be managed here. ## Step settings The Step settings panel allows you to fine-tune each step by adjusting its specific parameters based on your business and compliance needs. When a step is selected, this panel provides configuration options. **Step titles appear in two places:** on the progress indicator shown to users resuming the flow on mobile or desktop, and in the video call operator's frame, where they're used to manually trigger steps. ### **Step titles** * **Purpose**: Step titles are used for display purposes in various contexts: * Displayed as main title on the user's side. * When a user switches to a mobile device, the desktop screen displays the current step they are on. * **Tip**: Choose clear and descriptive step titles to improve the user experience and help operators navigate the process efficiently. ### Advanced tab The **Advanced** tab stores all the necessary keys for steps, questions, and answers to facilitate integrations with external systems. These keys can be used for API integrations or other external applications that interact with the verification flow. **Purpose** * **Step keys** – Unique identifiers for each verification step. * **Question keys** – Identifiers for the specific questions in forms or questionnaires. * **Answer keys** – Corresponding keys for answers provided by users in questionnaire steps. These keys enable seamless integration with other systems and facilitate tracking and reporting of data. *** ## Steps ### Language * **Purpose**: The Language step allows users to select their preferred interface language from a dropdown list before proceeding with verification. * **Positioning**: This step is **always positioned first** in the workflow. * **Step parameters**: * Define the list of **available languages** that users can choose from. * You must select at least **two languages** to enable the dropdown selection. * **Tip**: If your users primarily speak a specific language, consider setting a **default language** in the general settings, while still offering alternative options for accessibility. *** ### User questionnaire **Purpose:** The User questionnaire step is designed to collect structured user input through various form types. The provided information is securely stored within the verification session. Questionnaire steps offer a wide range of configurable question formats. #### Questionnaire details * **Title** – The main title of the questionnaire. * **Description** – A brief text displayed below the title to provide context. * **Success button title** – Customizable text for the confirmation button. #### Questions and answers Identomat supports a variety of question types, all of which offer customizable parameters: #### Short answer Users can type in a response to an open-ended question. * **Question title** – The label for the question. * **Answer format** - Defines the expected structure of the user’s response. This setting controls how the input is validated and which type of data the system accepts. * **Free text** - Users can enter any text without restrictions. * **Email -** Users must enter a valid email address; the system enforces email format validation. * **Prefilled answer** – A prefilled answer that the user can edit. * **Required** – Determines whether the question must be answered. * **Read-only mode** – Prevents users from editing the default answer. * **Condition** – The question only appears if a specified condition is met. #### Checkbox (Multiple selection) Users can select one or more predefined options. * **Question title** – The label for the question. * **Default answer** – Pre-checked options that users can modify. * **Required** – Determines if at least one option must be selected. * **Read-only mode** – Prevents users from modifying selections. * **Condition** – The question only appears if a specified condition is met. * **`+ Add option`** – Define multiple selectable choices. #### Radio (Single selection) Users can select only one option from a predefined list. * **Question title** – The label for the question. * **Default answer** – Preselected option that users can change. * **Required** – Determines if a selection is mandatory. * **Read-only mode** – Prevents users from modifying selections. * **Condition** – The question only appears if a specified condition is met. * **`+ Add option`** – Define the available choices. #### **File upload** Users can upload files, such as images or PDFs. * **Question title** – The label for the question. * **Description** – Additional instructions displayed under the title. * **Maximum number of files** – Limit the number of files users can upload (max: 10). * **File types** – Restrict uploads to **PDFs**, **images**, or both. * **Required** – Determines if file upload is mandatory. * **Condition** – The question only appears if a specified condition is met. #### **Dropdown** Allows users to select one or multiple values from a predefined dropdown list. * **Question title** – The label for the question. * **Dropdown options** – Define the dropdown list by providing options in a comma-separated format (e.g., *Option 1, Option 2, Option 3*). * **Multi-select** – If enabled, users can select multiple options from the dropdown list. If disabled, users can select only one option. * **Required** – Determines if a selection is mandatory. * **Error message** – The message displayed if the field is required but no selection is made. * **Condition** – The question only appears if a specified condition is met. #### **Attachment** Allows users to access files that are either uploaded by operators during the session or pre-attached by administrators via the no-code builder or API. * **Title** – The label for the question. * **Description** – Additional instructions displayed under the title. * **File attachment mode (Radio)** – Define how files are provided to the user: * **Uploaded by operator per session** – Operators can upload files during the session that are visible to the user. * **Allow changes to attachments after user confirmation -** If toggle is **turned off,** the operator cannot edit attachments after the user **confirms** the questionnaire. If **enabled**, the operator may still upload or remove files. * **Pre-attached file** – Files uploaded in advance via the no-code configurations or API. * **Maximum number of files** – Limit the number of files users can upload (max: 10). * **File types (Checkbox)** – Restrict uploads to **PDFs**, **images**, or both. * **Condition** – The attachment field only appears if a specified condition is met. *** ### Company data **Purpose:** The Company Data step collects essential information about a legal entity during KYB verification. This information is required to validate the company’s identity and ensure compliance with regulatory requirements. **Tip:** Always include the mandatory fields required for legal compliance. Use optional fields to gather extra information useful for business or regulatory purposes. #### **Step fields** * **Company name** – Mandatory; cannot be deleted. * **Registration number** – Mandatory; cannot be deleted. * **Registration country** – Mandatory; cannot be deleted. #### **Add field button** Allows administrators to include additional company information in the verification flow. The available fields include: * **VAT/Tax ID** * **Date of incorporation** * **Email** * **Phone number** * **Website** * **Legal address** * **Company entity type** Each added field includes a toggle to mark it as **required** or optional. *** ### Beneficiaries **Purpose:** The Beneficiaries step collects detailed information about a company’s key individuals and legal entities, such as shareholders, UBOs, directors, and representatives. This ensures compliance with regulatory requirements and enables verification workflows for both individuals and legal entities. **Tip:** Always configure the verification toggles and KYC/KYB dropdowns according to your compliance requirements. Mandatory fields cannot be removed, but optional fields can be added to capture additional information that may be useful for your internal processes or reporting. #### **Step details** * **Title** – The main label for the step. * **Description** – A brief explanation of the purpose of this step. * **Beneficiary verification** – Select how beneficiaries should be verified: * **Individuals** – Follow a **KYC flow**. * **Legal entities** – Follow a **KYB flow** using the chosen configuration. * **KYC dropdown** – Select a **KYC configuration** to use for individual verification. * **KYB dropdown** – Select a **KYB configuration** to use for company verification. * **`+ Add beneficiary`**** button** – Adds a new beneficiary entry to the step. #### **Available roles:** **Shareholders** * **Verification toggle** – Activates when a KYC or KYB configuration is selected in the dropdown. * **Tabs:** Individual and Company **Individual fields** (mandatory, cannot be deleted) * First name * Last name * Date of birth **Add field button** – Additional optional fields: * Beneficial ownership percentage * Phone number * Email Each added field can be marked as **required** or optional. **Company fields** (mandatory, cannot be deleted) * Company name * Registration number * Registration country **Add field button** – Additional optional fields: * Beneficial ownership percentage * Website * VAT/Tax ID * Date of incorporation * Email * Phone number * Legal address Each added field can be marked as **required** or optional. #### **UBOs (Ultimate Beneficial Owners)** * **Verification toggle** – Activates when a KYC configuration is selected. **Fields** (mandatory, cannot be deleted) * First name * Last name * Date of birth **Add field button** – Additional optional fields: * Beneficial ownership percentage * Phone number * Email Each added field can be marked as **required** or optional. #### **Directors** * **Verification toggle** – Activates when a KYC configuration is selected. **Fields** (mandatory, cannot be deleted) * First name * Last name * Date of birth **Add field button** – Additional optional fields: * Phone number * Email Each added field can be marked as **required** or optional. #### **Representatives** * **Verification toggle** – Activates when a KYC configuration is selected. **Fields** (mandatory, cannot be deleted) * First name * Last name * Date of birth **Add field button** – Additional optional fields: * Phone number * Email Each added field can be marked as **required** or optional. #### **Other** * **Verification toggle** – Activates when a KYC configuration is selected. **Fields** (mandatory, cannot be deleted) * Position * First name * Last name * Date of birth **Add field button** – Additional optional fields: * Phone number * Email Each added field can be marked as **required** or optional. *** # Developer guide The Developer Guide provides comprehensive instructions and best practices for integrating with our platform. [Identomat](https://www.identomat.com/) is a service designed to verify **human identity** and **liveness** over the Internet. This guide assumes that the integrating organization (hereafter referred to as *"the company"*) operates a web server (referred to as *"the company server"*) at `example.com` . ### Prerequisites Before integrating, the company must obtain a `company_key` — a credential used to securely communicate between the company server and the Identomat server (`widget.identomat.com`). {% hint style="info" %} Don't have a `company_key` yet? See [**API access**](/get-started/api-access) for how to generate one from your Identomat dashboard. {% endhint %} **Optional security features, configurable at key generation or any time after:** * **HMAC authorization** — A `secret_key` is used to generate and validate HMAC signatures, adding an extra layer of verification to requests sent with your `company_key`. * **IP whitelisting** — Restrict a `company_key` to a specific set of IP addresses. Once IPs are added, only requests carrying that key from a whitelisted address are accepted; requests from any other IP are rejected. Leaving the list empty allows the key to be used from any IP. Both settings can be added, edited, or removed at any time from the same section of your dashboard where the key was generated. For enhanced security, companies can optionally implement **HMAC authorization**. In this case, a `secret_key` is used to generate and validate HMAC signatures for secure communication. ## Procedure The integration procedure consists of three main steps: {% stepper %} {% step %} [**Acquiring a `session_token`.**](#acquiring-a-session-token) {% endstep %} {% step %} [**Redirecting the user's browser to `widget.identomat.com`.**](#redirecting-to-the-identomat-widget) {% endstep %} {% step %} [**Checking for a result.**](#checking-for-a-result) {% endstep %} {% endstepper %} ### **Acquiring a session token** To acquire a `session_token`, your backend must send a request to the `/begin/` endpoint with the following parameters: * `company_key` – Your unique company identifier. * `flags` – A JSON object defining global settings for the verification session. * `steps` – An array specifying the steps to include in the verification flow. Each step can have its own step-specific flags. > ⚠️ The `session_token` is valid for **15 minutes** by default. **Endpoint:** ```nginx POST https://widget.identomat.com/begin/ ``` Requests can be sent as: * **URL query parameters** * **URL-encoded form data** * **JSON object** in the request body (recommended) #### **Steps and Flags Structure** * `flags` : Defines global behavior for the entire session. * `steps` : Allows full control of the verification process, enabling you to specify **which steps to include** (e.g., `liveness`, `identity-document`) and configure **step-specific flags**, such as `"allow_face_upload": true` for the `liveness` step. {% hint style="info" %} To ensure compatibility between the old and new methods, both of which need to work together, you should use the `'skip_face'` and `'skip_document'` flags when using steps. These flags prevent the 'identity-document' and 'liveness' steps from being duplicated if they already exist in the flow. {% endhint %} **Using Configuration or custom steps** You can initiate a session in two ways: * **Via predefined configuration (Recommended):** * We strongly recommend using **predefined configurations** via the `config_id` parameter. Configurations ensure consistency, simplify integration, and reduce the risk of errors. Using configurations also allows us to deprecate legacy custom step handling in the future, helping clients maintain a clean and stable integration. * **Via custom steps and flags**:\ Only use custom steps and flags if you have very specific needs that cannot be satisfied with configurations. Over time, we encourage migrating all custom flows to configurations. {% hint style="warning" %} **Why configurations matter:** * **Simplifies session creation** — no need to manually define steps and flags. * **Reduces risk of errors** in the verification flow. * **Future-proof** — legacy custom step handling will eventually be deprecated. * Enables Identomat to **maintain**, **improve**, and **optimize** **flows** efficiently. * Makes **integration** easier. {% endhint %} {% hint style="info" %} 📘 For detailed parameter definitions and examples, refer to the [**API Reference.**](/developer-tools/api-reference#begin-session-creation) {% endhint %} ### Redirecting to the Identomat Widget To start a verification session, the company server must redirect the user’s browser to: ``` https://widget.identomat.com/?session_token={session_token_here} ``` Replace `{session_token_here}` with the actual token received from the `/begin/` endpoint. ### Embedding in an Iframe Alternatively, the widget can be embedded within an iframe: ```html ``` {% hint style="warning" %} The `allow="camera"` attribute is required to grant camera access. Without it, verification steps that rely on the camera will not function. {% endhint %} ### **Checking for a result** Once the verification process is completed, the result can be detected in two ways depending on how the widget was integrated: * **If** **redirected**\ If you used a redirect approach (not embedded in an iframe), the user will be redirected to the `return_url` specified in the configuration or session flags, with the `session_token` appended as a query parameter. ``` https://yourapp.com/?session_token=abc123xyz ``` * **If embedded in an iframe**, the process completion can be detected using JavaScript: ```javascript addEventListener('message', function (e) { if (e.origin !== 'https://widget.identomat.com') return; if (e.data !== 'DONE') return; // Process completed, handle results here }); ``` {% hint style="success" %} Ensure you verify the message `origin` to avoid security risks. {% endhint %} *** ## Quick links Access detailed developer guides for **KYC (Know Your Customer)** and **KYB (Know Your Business)** flows. Click a card below to explore configuration, integration steps, and best practices for each verification type.


KYC (Know Your Customer) Learn how to collect and verify individual user data, configure verification steps, and integrate KYC flows.	/pages/zp3PlfI2jqthOVkWQNJW
KYB (Know Your Business) Learn how to collect and verify company data, beneficiaries, and representatives, with configurable verification steps.	/pages/PcRaMELPuaahtgUUMEyI

KYC (Know Your Customer)

Learn how to collect and verify individual user data, configure verification steps, and integrate KYC flows.

/pages/zp3PlfI2jqthOVkWQNJW

KYB (Know Your Business)

Learn how to collect and verify company data, beneficiaries, and representatives, with configurable verification steps.

/pages/PcRaMELPuaahtgUUMEyI

# KYC (Know Your Customer) The KYC flow verifies the identity of individual users through document checks, liveness detection, and automated data validation. Each KYC verification flow consists of configurable steps that define how the end user’s identity is verified. The flags and steps listed below determine which checks are included in the process and how they are executed. ## Flags The `flags` parameter is an object with optional configuration flags that adjust the KYC 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>
`requiredHdMedia`	Enforces Full HD (1080p+) camera usage for `liveness` and `identity-document` steps. If not met, a QR code is shown for the user to switch to another device.	`false`	<boolean>

## Steps The `steps` array defines the sequence and structure of the identification process. It is included alongside the `company_key` and `flags` parameters when creating a session. Each step in the `steps` array can contain the following 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](#language) * [ID verification](#identity-document-verification) * [Liveness check](#liveness-check) * [Proof of Address](#proof-of-address) * [Selfie with ID](#selfie-with-id) * [Video call](#video-call) * [Phone number verification](#phone-number) * [Email verification](#email) * [Geolocation](#geolocation) * [AnyDoc reader](#anydoc-reader) * [SSN verification](#ssn-verification) * [User questionnaire](#user-questionnaire) * [Operator questionnaire](#operator-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

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>

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

```bash 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 } } ] }' ```

*** ### Identity document verification The Identity Document step involves users scanning or uploading photos of their ID documents. **Identity document step configurations:** * **Title:** `ID verification` * **Type**: `identity-document` * **Key**: `identity-document` * **Flags:** * disable\_document\_capture * allow\_document\_upload * document\_types * document\_countries

Flag	Description	Default	Type
`disable_document_capture`	Disables live document scanning. Users can only upload images of their documents.	`false`	<boolean>
`allow_document_upload`	Enables the option to either scan or upload the document.	`false`	<boolean>
`allow_nfc_capture`	Enables NFC chip reading for supported identity documents (e.g. biometric passports and IDs). When enabled, users can scan the document’s NFC chip using a compatible device.	`false`	<boolean>
`document_types`	A list of allowed document types. Possible values: `"id", "passport", "driver_license", "residence_license"`	All types	Array<string>
`document_countries`	Restricts accepted document issuers to specific country codes. (e.g., `"USA", "DEU", "ITA"`)	Unrestricted	Array<string>
`optional_continue_on_another_device`	Allows users to optionally switch to another device to continue the session.	`false`	<boolean>

#### **cURL example:** Example using cURL with **`return_url`** & **`language`** flags and an **`identity-document`** verification step:

Expand to view example

```bash 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": { "es": "ID verification" }, "type": "identity-document", "key": "select_document_id", "flags": { "allow_document_upload": true, "document_types": [ "id", "passport", "driver_license", "residence_license" ] } } ] }' ```

#### **Document data review** When enabled, users are presented with a review page after document scanning, where they can verify and correct the extracted data before submission. To enable Document data review, add a `review` object to the step configuration:

Flag	Description	Default	Type
`check`	Enables the Document data review page.	`false`	`<boolean>`
`allowedUsers`	Defines who can edit the extracted data on the review page. Possible values: `"client"` (the end user completing the verification), `"operator"` (operator supervising the session).	—	`Array<string>`
`fields`	A map of OCR fields to include in the review page. Each field can be configured with `editable` and `mandatory` properties.	—	`Object`

**Field configuration properties:**

Flag	Description	Type
`type`	Data type of the field. Possible values: `"string"`, `"datestring"`	`<string>`
`editable`	Whether the user or operator can edit this field.	`<boolean>`
`mandatory`	Whether the field must be filled before submission.	`<boolean>`

**Configurable fields:** | Field | Key | Component | | ---------------------- | ---------------------- | ---------------- | | First Name (Eng.) | `firstNameEn` | Text input | | First Name (Local) | `firstNameLocal` | Text input | | Middle Name (Eng.) | `middleNameEn` | Text input | | Middle Name (Local) | `middleNameLocal` | Text input | | Last Name (Eng.) | `lastNameEn` | Text input | | Last Name (Local) | `lastNameLocal` | Text input | | Father's Name (Eng.) | `fatherNameEn` | Text input | | Father's Name (Local) | `fatherNameLocal` | Text input | | Date of Birth | `dateOfBirth` | Date picker | | Place of Birth | `placeOfBirth` | Text input | | Sex | `sex` | Radio button | | Citizenship | `citizenship` | Country dropdown | | Nationality | `nationality` | Country dropdown | | Document Number | `documentNumber` | Text input | | Authority | `authority` | Text input | | Document Expires On | `documentExpireDate` | Date picker | | Document Issuing Date | `documentIssuingDate` | Date picker | | Document Issuing State | `documentIssuingState` | Country dropdown | | Personal Number | `personalNumber` | Text input | | Address | `address` | Textarea | | State | `state` | Text input | **Source trust hierarchy** Fields populated from a trusted source are permanently **read-only**, regardless of the `editable` configuration. This rule is enforced at the backend level and cannot be overridden. The following sources produce non-editable fields: * `NFC` * `MRZ` * `QR` **Example configuration:**

Expand to view example

```bash { "type": "identity-document", "key": "select_document_id", "title": { "en": "ID verification" }, "flags": { "document_types": ["id", "passport", "driver_license", "residence_license"], "allow_document_upload": true, "disable_document_capture": false }, "review": { "check": true, "allowedUsers": ["client", "operator"], "fields": { "firstNameEn": { "type": "string", "editable": true, "mandatory": true }, "firstNameLocal": { "type": "string", "editable": true, "mandatory": true }, "middleNameEn": { "type": "string", "editable": true, "mandatory": true }, "middleNameLocal": { "type": "string", "editable": true, "mandatory": true }, "lastNameEn": { "type": "string", "editable": true, "mandatory": true }, "lastNameLocal": { "type": "string", "editable": true, "mandatory": true }, "fatherNameEn": { "type": "string", "editable": true, "mandatory": true }, "fatherNameLocal": { "type": "string", "editable": true, "mandatory": true }, "dateOfBirth": { "type": "datestring", "editable": true, "mandatory": true }, "placeOfBirth": { "type": "string", "editable": true, "mandatory": true }, "sex": { "type": "string", "editable": true, "mandatory": true }, "citizenship": { "type": "string", "editable": true, "mandatory": true }, "nationality": { "type": "string", "editable": true, "mandatory": true }, "documentNumber": { "type": "string", "editable": true, "mandatory": true }, "authority": { "type": "string", "editable": true, "mandatory": true }, "documentExpireDate": { "type": "datestring", "editable": true, "mandatory": true }, "documentIssuingDate": { "type": "datestring", "editable": true, "mandatory": true }, "documentIssuingState": { "type": "string", "editable": true, "mandatory": true }, "personalNumber": { "type": "string", "editable": true, "mandatory": true }, "address": { "type": "string", "editable": true, "mandatory": true }, "state": { "type": "string", "editable": true, "mandatory": true } } } } ```

*** ### **Liveness check** The **Liveness** step verifies that the user is physically present by analyzing a live facial image or video. Identomat supports two types of liveness verification: * **Passive liveness:** The user aligns their face within an oval frame while the system captures a short (approx. 2-second) video. * **Active liveness:** The user performs specific actions to confirm their presence as a live person. **Liveness check step configurations:** * **Title:** `Liveness` * **Type**: `liveness` * **Key**: `liveness` * **Flags:** * liveness * allow\_face\_upload * adaptive\_liveness * instructions

Flag	Description	Default	Type
`liveness`	Defines the type of liveness check: `true`: active liveness `false`: passive liveness	`false`	<boolean>
`allow_face_upload`	Allows the user to upload a selfie instead of using the camera. ⚠️ This flag is ignored if `liveness` is `true`, as active checks require live input.	`false`	<boolean>
`optional_continue_on_another_device`	Allows users to optionally switch to another device to continue the session.	`false`	<boolean>
`adaptive_liveness`	(SDKs only) Enables the new Adaptive liveness experience with improved UI and detection. Must be `true` to use Adaptive Liveness. ⚠️ If `adaptive_liveness` is `true`, the `liveness` flag must be `false`.	`false`	<boolean>
`instructions`	Defines the actions the user must perform for Adaptive Liveness. Only applicable if `adaptive_liveness` is `true`. Currently supported option: `[ "smile" ]`.	`[ "smile" ]`	Array<string>

#### **cURL example:** Example using cURL with **`document_countries`** & **`language`** flags and **`identity-document`** verification & *active* **`liveness`** steps:

Expand to view example

```bash curl https://widget.identomat.com/external-api/begin/ -d '{ "company_key": "your_company_key_here", "flags": { "language": "en" }, "steps": [ { "title": { "en": "ID verification" }, "type": "identity-document", "key": "select_document_id", "flags": { "allow_document_upload": true, "document_types": [ "id", "passport", "driver_license", "residence_license" ], "document_countries": [ "USA", "FRA" ] } }, { "title": { "en": "Liveness check" }, "type": "liveness", "key": "liveness", "flags": { "liveness": true } } ] }' ```

*** ### Proof of Address The POA step includes verification of Proof of Address and analysis of other types of documents. This step supports a wide range of general document types, such as utility bills or bank statements. **Proof of Address step configurations:** * **Title:** `Proof of Address` * **Type**: `general-document` * **Key**: `select_general_document` * **Flags:** * general\_document\_types

Flag Description Default Type

Flag	Description	Default	Type
`general_document_types`	A list of allowed document types. If omitted or set to an empty array, all document types will be available for upload. Possible values: `"bank_statement", "utility_bill", "yellow_slip", "drivers_license", "vehicle_registration_certificate"`	All types	<array>

general_document_types

A list of allowed document types.
If omitted or set to an empty array, all document types will be available for upload.

Possible values:

"bank_statement", "utility_bill", "yellow_slip", "drivers_license", "vehicle_registration_certificate"

All types

<array>

#### **cURL example:** Example using cURL with **`optional_continue_on_another_device`** & **`language`** flags and **`liveness`** & **`general-document`** steps:

Expand to view example

```bash curl https://widget.identomat.com/external-api/begin/ -d '{ "company_key": "your_company_key_here", "flags": { "optional_continue_on_another_device": true, "language": "en" }, "steps": [ { "title": { "en": "Liveness check" }, "type": "liveness", "key": "liveness", "flags": { "liveness": true } }, { "title": { "en": "Proof of address" }, "type": "general-document", "key": "select_general_document", "flags": { "general_document_types": [ "bank_statement", "utility_bill", "yellow_slip", "drivers_license", "vehicle_registration_certificate" ] } } ] }' ```

*** ### Selfie with ID In the Selfie with ID step, users are required to hold their document in their hands so that both their face and the document are visible. **Selfie with ID step configurations:** * **Title:** `Selfie with ID` * **Type**: `face-document` * **Key**: `capture_face_document` * **Flags:** * allow\_face\_doc\_upload * require\_face\_document

Flag	Description	Default	Type
`allow_face_doc_upload`	Allows users to upload an image of themselves holding the document.	`false`	<boolean>
`require_face_document`	Requires users to capture themselves holding the document live.	`false`	<boolean>
`optional_continue_on_another_device`	Allows users to optionally switch to another device to continue the session.	`false`	<boolean>

#### **cURL example:** Example using cURL with **`restrict_url_sharing`** & **`language`** flags and **`face-document`** step:

Expand to view example

```bash curl https://widget.identomat.com/external-api/begin/ -d '{ "company_key": "your_company_key_here", "flags": { "restrict_url_sharing": true, "language": "en" }, "steps": [ { "title": { "en": "Selfie with ID" }, "type": "face-document", "key": "capture_face_document", "flags": { "allow_face_doc_upload": true, "require_face_document": true } } ] }' ```

*** ### Video call In the Video call step, the user connects with an operator for a live verification. This can include any of the Identomat verification steps. Identomat offers two call modes: * **One-on-one:** Involves a secure video call between a customer and a verification operator * **Multi-user call:** Enables the verification of multiple customers within a single session. Each user can follow their own customized workflow tailored to the specific business process. **Video call step configurations:** * **Title:** `Video call` * **Type**: `video-call` * **Key**: `video-call` * **Array** of `steps` * **resetSteps**: `true/false` *(optional)* * **hideCameraOption**: `true/false` *(optional)* * **nameRequired***:* `true/false` *(optional)* * **multiple\_participants:** `true/false` *(optional)*

Flag	Description	Default	Type
`steps`	List of steps to run during the video call (except `language` and `operator_questionnaire`).	`[ ]`	<array>
`resetSteps`	If true, user verification data resets when they rejoin the call.	`false`	<boolean>
`hideCameraOption`	Enabling this will hide the camera icon, preventing users from turning off the camera.	`false`	<boolean>
`nameRequired`	Requires users to enter their name before joining.	`false`	<boolean>
`multiple_participants`	Enables multi-user video sessions.	`false`	<boolean>

#### **cURL example:** Example using cURL with **`return_url`** & **`language`** flags and **`video-call`** with **`identity-document`** step:

Expand to view example

```bash curl https://widget.identomat.com/external-api/begin/ -d '{ "company_key": "your_company_key_here", "flags": { "return_url": "https://example.com/", "language": "es" }, "steps": [ { "type": "video-call", "title": { "es": "video-call" }, "key": "video-call", "steps": [ { "title": { "es": "ID verification" }, "type": "identity-document", "key": "select_document_id", "flags": { "document_types": [ "id", "passport", "driver_license", "residence_license" ] } } ] } ] }' ```

*** ### Phone number Phone number verification allows users to verify or submit their phone number. Phone number step may include: * **Verification** of the user's phone number using an OTP code. * **Collection** of the user's phone number. **Phone number step configurations:** * **Type**: `phone-number` * **Key**: `phone_number` * **Flags:** * require\_phone\_number\_check * require\_phone\_number

Flag	Description	Default	Type
`require_phone_number_check`	Requires users to verify their number via an OTP code.	`false`	<boolean>
`require_phone_number`	Requires users to submit a phone number without verification.	`false`	<boolean>

#### **cURL example:** Example using cURL with **`return_url`** & **`language`** flags and **`phone-number`** step:

Expand to view example

```bash curl https://widget.identomat.com/external-api/begin/ -d '{ "company_key": "your_company_key_here", "flags": { "return_url": "https://example.com/", "language": "it" }, "steps": [ { "title": { "it": "Phone number verification" }, "type": "phone-number", "key": "phone_number", "flags": { "require_phone_number_check": true } } ] }' ```

*** ### Email The Email step allows users to verify or submit their email address. Email step may include: * **Verification** of the user's email using an OTP code. * **Collection** of the user's email. **Email step configurations:** * **Type**: `email` * **Key**: `require_email` * **Flags:** * require\_email\_check * require\_email

Flag	Description	Default	Type
`require_email_check`	Requires email verification via an OTP code.	`false`	<boolean>
`require_email`	Requires users to submit an email without verification.	`false`	<boolean>

#### **cURL example:** Example using cURL with **`return_url`** & **`language`** flags and **`email`** step:

Expand to view example

```bash curl https://widget.identomat.com/external-api/begin/ -d '{ "company_key": "your_company_key_here", "flags": { "return_url": "https://example.com/", "language": "en" }, "steps": [ { "title": { "en": "Email verification" }, "type": "email", "key": "require_email", "flags": { "require_email_check": true } } ] }' ```

*** ### Geolocation The Geolocation step requests the user’s location data by prompting for browser permission. **Geolocation step configurations:** * **Type**: `geolocation` * **Key**: `require_geolocation` * **Flags:** * require\_geolocation

Flag	Description	Default	Type
`require_geolocation`	Requires location access to proceed through the step.	`true`	<boolean>

#### **cURL example:** Example using cURL with **`return_url`** & **`language`** flags and **`geolocation`** step:

Expand to view example

```bash curl https://widget.identomat.com/external-api/begin/ -d '{ "company_key": "your_company_key_here", "flags": { "return_url": "https://example.com/", "language": "en" }, "steps": [ { "title": { "en": "Geolocation" }, "type": "geolocation", "key": "require_geolocation", "flags": { "require_geolocation": true } } ] }' ```

*** ### **AnyDoc reader** The AnyDoc step lets you extract structured data **from any document** type using AI - such as payslips, bank statements, utility bills, or tax certificates. You define the fields you want extracted, and the system reads and validates them automatically. **AnyDoc step configurations:** * **Title:** `AnyDoc upload` * **Type**: `anydoc-reader` * **Key**: client-defined, must remain unique within the session * **Parameters:** * `documentType` * `allowedFormats` * `pageConfiguration` * `pageCount` * `documentValidity` * `language` * `extractionHint` * `confidenceThreshold` * `retryLimit` * `fields`

Parameter	Description	Default	Type
`documentType`	Free-text label identifying the document type (e.g. "Payslip", "Bank Statement"). Used internally across session details and API output. Required.	-	<string>
`allowedFormats`	File formats accepted for upload. Possible values: `"pdf"`, `"image"`	All types	Array<string>
`pageConfiguration`	Whether the document is expected to be single or multi-page. Possible values: `"single"`, `"multiple"`	`"single"`	<string>
`pageCount`	Expected number of pages, used only when `pageConfiguration` is `"multiple"`. If omitted, all uploaded pages are processed.	null	<number>
`documentValidity`	Enforces a maximum document age based on a date field extracted from the document. See breakdown below.	`{ "enabled": false }`	<object>
`language`	The expected language of the document, used to guide extraction accuracy. If omitted, the language is auto-detected.	Auto-detect	<string>
`extractionHint`	Additional context about the document as a whole, provided to the AI alongside field-level hints. Recommended in English regardless of document language.	null	<string>
`confidenceThreshold`	Minimum confidence score (0–100) required for an extracted field to be accepted without flagging. Applies to all fields unless overridden per field.	`80`	<number>
`retryLimit`	Maximum number of times the user can upload or capture a document in this step.	`3`	<number>
`fields`	An array of field objects defining the data to extract. See breakdown below.	-	Array<object>

#### **`documentValidity` object:**

Property	Description	Default	Type
`enabled`	Turns the validity check on or off.	`false`	<boolean>
`dateField`	The `key` of a field (must be of type `date`) whose extracted value is checked against `maxAge`. Required when `enabled` is `true`.	-	<string>
`maxAge`	Maximum allowed document age, as a `value` + `unit` pair. Possible `unit` values: `"days"`, `"weeks"`, `"months"`, `"years"`.	-	<object>

#### **Fields** Each object in the `fields` array defines a single piece of data to extract from the document.

Parameter	Description	Default	Type
`key`	Unique identifier for the field within the step. Used to reference the extracted value in API output. Required.	-	<string>
`type`	Determines how the extracted value is validated and formatted. Possible values: `"text"`, `"number"`, `"date"`, `"boolean"`, `"email"`, `"phone"`, `"currency"`, `"money"`, `"iban"` `"taxId"`, `"address"`, `"percentage"`, `"other"`	-	<string>
`otherTypeLabel`	Free-text description of the data this field contains. Used only when `type` is `"other"`; if left blank, the AI treats the field as free text with no format validation.	null	<string>
`label`	Display name of the field, used to help identify it in the document and shown in session details. Optional if `extractionHint` is provided.	-	<string>
`alternativeNames`	Comma-separated alternative terms this field may appear as in the document (e.g. "Sex, Male/Female" for a Gender field). Used only to inform extraction, not shown in review or API output.	null	<string>
`mandatory`	Whether the session is flagged if this field cannot be extracted.	`false`	<boolean>
`confidenceThreshold`	Overrides the step-level `confidenceThreshold` for this specific field.	Inherits step default	<number>
`extractionHint`	Additional context about this field, provided to the AI when extracting its value. Recommended in English regardless of document language. Optional if `label` is provided.	null	<string>

> **Note:** At least one of `label` or `extractionHint` must be provided per field, so the AI has something to search for. #### **cURL example:** Example using cURL with `anydoc-reader` step:

Expand to view example

```bash 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": "anydoc-reader", "key": "anydoc-payslip-1", "title": { "en": "AnyDoc upload" }, "description": { "en": "Upload your most recent payslip so we can confirm your stated income." }, "documentType": "Payslip", "allowedFormats": ["pdf", "image"], "pageConfiguration": "multiple", "pageCount": 2, "documentValidity": { "enabled": true, "dateField": "issue-date", "maxAge": { "value": 3, "unit": "months" } }, "language": "en", "extractionHint": "This is a European payroll slip. Salary figures may use either comma or period as decimal separator.", "confidenceThreshold": 80, "retryLimit": 3, "fields": [ { "key": "employee-name", "type": "text", "label": "Employee name", "mandatory": true }, { "key": "issue-date", "type": "date", "label": "Issue date", "mandatory": true }, { "key": "net-salary", "type": "money", "label": "Net salary", "mandatory": true, "confidenceThreshold": 90 } ] } ] }' ```

*** ### **SSN verification** The SSN verification step verifies a user's Social Security Number as part of the identification process. **SSN verification step configurations:** * **Title:** `SSN verification` * **Type**: `ssn` * **Key**: client-defined, must remain unique within the session #### **cURL example:** Example using cURL with **`return_url`** & **`language`** flags and an **`ssn`** step:

Expand to view example

*** ### 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 \

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 you 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" }`

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" }`
`format`	Specifies the expected structure of the user’s response. Determines how the input is validated.	`free-text`	<object>	`"format": { "type": "free-text" }` `"format": { "type": "email" }` `"format": { "type": "contactNumber" }`
`mandatory`	Specifies whether the question is required to be answered. Possible values: `true`, `false`	false	<boolean>	`"mandatory": true`
`answer`	Allows you 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" }`

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 you 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" }`

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 you 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" }`

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" }`

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" }`

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`

Parameter name	Description	Default	Type
`name`	A custom session label shown in the dashboard before the user completes verification. Once the session is completed, this value is replaced with the verified user's name (if available).	null	<string>
`clientUserId`	A unique identifier used to link the session to a specific user in your system. This is useful for grouping sessions or syncing with your internal user or account IDs.	null	<string>
`groupId`	Defines the group assigned to the session. For example, in a video call, only members of this specified group will be able to receive the call.	null	<string>
`scheduleStartTime`	The datetime when the session becomes available to the end-user. Before this time, the session cannot be started. Format: ISO 8601 — e.g., `"2024-06-20T07:33:00.000Z"`	null	<string> (ISO 8601 datetime)
`scheduleEndTime`	The datetime after which the session is no longer accessible to the end-user. Format: ISO 8601 — e.g., `"2024-06-20T09:00:00.000Z"`	null	<string> (ISO 8601 datetime)

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>

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

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>

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

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

Field	Description
`id`	The parent session ID. Use this to track the session in Manage and receive callbacks.
`url`	The applicant-facing URL for the child session. Mirrors `additionalSessionUrl` for backwards compatibility.
`additionalSessionId`	The child session ID. Only present when `additionalInformationRequest` is enabled on the configuration.
`additionalSessionUrl`	The applicant-facing URL for the child session. Only present when `additionalInformationRequest` is enabled on the configuration.

Field	Possible values	Meaning
roomStatus	`created`	Room successfully created; call is in progress.
	`ended`	Operator ended the call.
	`empty`	The video call room ended with no media recorded.
compositionStatus	`null`	Composition not started yet.
	`started`	Composition (video merging) has started.
	`available`	Composed full video is ready.
videoFileStatus	`null`	Final video file has not been generated yet.
	`started`	Video file generation has started.
	`available`	Final downloadable video file is ready.
videoFileId	`null` or File ID	If available, this ID can be used to download the composed video.

Step type	Description
`company`	Company information submitted in the flow.
`beneficiaries`	List of UBOs and representatives (individuals or companies). Each individual beneficiary includes a KYC `sessionId` that can be queried via the KYC endpoint.
`kyb-review`	Final review status and trusted database data.

Value	Description
`APPROVED`	The session was approved.
`REJECTED`	The session was rejected.
`MANUAL_CHECK`	The session requires manual review.
`ADDITIONAL_INFORMATION_REQUESTED`	The operator has requested further verification from the applicant.

Field	Description
callbackApiKey	Key used for authentication.
type	Always `"video-call-status-update"`.
sessionId	The ID of the verification session.
roomId	Unique identifier of the video room.
roomStatus	Indicates the state of the room (`empty`, `ended`).
compositionStatus	Status of composition file, if any (`available`, `null`).
videoFileStatus	Indicates whether the video file is ready (`available`, `null`).
videoFileId	Identifier of the uploaded video file, if available.

Tag	Source
OCR / MRZ / NFC / QR	Extracted automatically from the document via OCR, MRZ, NFC, or QR
User review	Edited by the applicant during document data review after scanning
User input	Entered by the applicant in the User questionnaire
Client provided	Preset by the client via API or Configuration before the session started
Operator	Entered or corrected by the operator during review

Question type	Mappable Person Data fields
Short answer (Free text or Number)	First Name, Last Name, Middle Name, Father's Name (Eng./Local), Place of Birth, Document Number, Personal Number, Authority, Address, State
Date	Date of Birth, Document Expires On, Document Issuing Date
Radio	Sex
Dropdown	Citizenship, Nationality, Document Issuing State

Property	Description
Value	The normalized, validated value (e.g. `EUR`, `2026-06-01`)
Raw value	The value exactly as it appeared in the document, before normalization (e.g. `€`, `01 Jun 2026`)
Confidence	A 0–100 score indicating how confident the AI is in the extracted value
Validation status	Whether the value passed, failed, or was not found


Via the No-code workflow builder: Configure the step directly in the Configuration builder.	/pages/TDDeRXDR3qst5wOR0CYs#anydoc-reader
Via API: The step is configured using the `anydoc-reader` step type. See AnyDoc in the Developer guide for the full configuration reference.	/pages/zp3PlfI2jqthOVkWQNJW#anydoc-reader


💻 Device	A device with a working camera and microphone
🪪 Document	A valid identity document — Passport, Identity Card, Residence Permit, or Driver's License
🌞 Lighting	A well-lit environment
🛜 Connection	A stable internet connection

Control	Function
Audio	Mute / unmute microphone
Video	Turn camera on / off
Flip	Mirror the camera view
Switch	Toggle between front and back camera (if available)
Join	Connect to the operator and start the call

Control	Function
Call duration	Shows elapsed call time
Virtual backgrounds	Apply or adjust a custom background during the call
Device settings	Adjust camera, microphone, and speaker
Full screen	Expand or minimize the video call frame


Огляд продукту	Дізнайтеся, що пропонує Identomat, про основні функції та як це допомагає оптимізувати процес верифікації особи.	/pages/PiaUbZlVB7zNFJK0yDuz
Початок роботи	Покрокова інструкція з налаштування облікового запису, конфігурації ролей та запуску вашого першого потоку верифікації.	/pages/40AyfbhUB8HyOfarMloy
Безкодовий конструктор робочих процесів	Легко проєктуйте та налаштовуйте потоки верифікації без написання коду, використовуючи конфігурації типу drag-and-drop.	/pages/N4BzMEIvD7Rm97iYWwIq
Відео-KYC	Дізнайтеся, як працює верифікація через живе відео для операторів та кінцевих користувачів, включно з механізмами контролю відповідності.	/pages/E1REAIPXyXgxs2CgYQzd
Інтеграція	Дослідіть різні способи інтеграції Identomat у ваші системи — через iframe, редирект або бекофіс.	/pages/8MIF4gBWpnF3x0xOD8Pw
Довідник API	Повний технічний довідник щодо REST API Identomat з прикладами запитів та відповідей.	/pages/lKEQbtIuRBKjodCxzrhN
SDK	Мобільні та веб-SDK (iOS, Android, Flutter, React Native) з інструкціями з налаштування та журналами змін.	/pages/ygvCp5lRMWeAkn26pwAt


Верифікація документів, що посвідчують особу	Автоматично перевіряйте державні посвідчення особи, паспорти та інші документи. Identomat забезпечує справді глобальне покриття, розпізнаючи тисячі типів документів зі 165+ країн.	/pages/k5L63NyPHDtlvo7uqhtA#identity-document-verification-verifikaciya-dokumenta-sho-posvidchuye-osobu
Перевірка живості (Liveness)	Підтвердіть справжню присутність власника документа за допомогою перевірки живості з використанням відео-селфі з підказками (активна) або без них (пасивна).	/pages/k5L63NyPHDtlvo7uqhtA#liveness-check-perevirka-zhivosti
AML-моніторинг	Перевірка та постійний моніторинг клієнтів за тисячами списків спостереження, санкційних списків, списків PEP (публічних осіб) та списків негативних медіа.	/pages/lKEQbtIuRBKjodCxzrhN#aml-skrining
Верифікація адреси	Автоматизоване OCR-розпізнавання та перевірка адреси для документів, що підтверджують адресу, як-от банківські виписки, рахунки за комунальні послуги тощо, у поєднанні з сигналами геолокації через IP та GPS.	/pages/k5L63NyPHDtlvo7uqhtA#proof-of-address-pidtverdzhennya-adresi
Відео-KYC	Верифікація через живий відеодзвінок з одним або кількома учасниками, із вбудованою функціональністю повного eKYC на основі ШІ для робочих процесів Human-in-the-Loop.	/pages/E1REAIPXyXgxs2CgYQzd
Опитувальники KYC	Настроюване рішення для збору необхідної інформації для належної перевірки клієнтів (Customer Due Diligence) із конструктором форм та логікою на основі відповідей.	/pages/k5L63NyPHDtlvo7uqhtA#user-questionnaire-opituvalnik-koristuvacha
Верифікація телефону та електронної пошти	Підтвердьте адресу електронної пошти та номер телефону потенційного клієнта за допомогою OTP, збагачуючи його профіль та додаючи рівень безпеки облікового запису.	/pages/k5L63NyPHDtlvo7uqhtA#phone-number-nomer-telefonu
Безкодовий конструктор конфігурацій	Легко налаштовуйте та розгортайте робочі процеси KYC — від захоплення та верифікації документів до підтвердження адреси, AML-перевірки, участі людини-оператора та іншого.	/pages/N4BzMEIvD7Rm97iYWwIq
Простота інтеграції та налаштування	Наша передова платформа верифікації особи пропонує настроювані робочі процеси, персоналізований UI/UX та модульну архітектуру з можливістю повного білого лейблу рішення.


100 x	у 100 разів швидша активація облікового запису порівняно з ручною верифікацією
40 сек	Середній час верифікації
60%	Менше відмов клієнтів
165+	Країн та територій
98%	Рівень конверсії


Налаштування облікового запису	Детальний посібник з налаштування вашого облікового запису Identomat.		/pages/UjOgPAjIghbuCPH3lpx6
Огляд інтеграції	Дізнайтеся, як інтегрувати Identomat з вашою системою.		/pages/MFH3l4dCutk9QYSUTWI9

Роль	Права доступу	Особливі можливості
Адміністратор	Повний доступ	Керування користувачами, налаштуваннями, конфігураціями, інтеграцією
Оператор	Помірний доступ	Керування панеллю керування, сесіями верифікації
Оператор кол-центру	Обмежений доступ	Отримання дзвінків від користувачів, керування власними сесіями


Безкодова інтеграція	Налаштуйте свій потік верифікації та надсилайте посилання на верифікацію кінцевим користувачам безпосередньо з платформи Manage — без потреби в розробці.	/pages/qggw3kB0kT4Fib0Q35rp
SDK Identomat	Нативні SDK для iOS, Android, Flutter та React Native. Охоплюють налаштування, конфігурацію та ключові функції для безперешкодної верифікації особи всередині застосунку.	/pages/ygvCp5lRMWeAkn26pwAt
API Identomat	REST API для повного контролю над створенням сесій, конфігурацією та отриманням результатів. Ідеально підходить для індивідуальних інтеграцій та серверних робочих процесів.	/pages/lKEQbtIuRBKjodCxzrhN


Посібник для розробників	Покрокові інструкції та найкращі практики для інтеграції та налаштування наших рішень з верифікації особи.		/pages/8MIF4gBWpnF3x0xOD8Pw
Довідник API	Вичерпні відомості про ендпоінти, параметри та формати відповідей для безперешкодної інтеграції API.		/pages/lKEQbtIuRBKjodCxzrhN

Назва прапорця	Опис	За замовчуванням	Тип
`skip_face`	Пропускає крок `liveness`, якщо він вже існує у визначених кроках. Запобігає дублюванню при використанні власних потоків.	`false`	<boolean>
`skip_document`	Пропускає крок `identity-document`, якщо він вже існує у визначених кроках. Запобігає дублюванню при використанні власних потоків.	`false`	<boolean>
`return_url`	URL для перенаправлення користувача після завершення процесу ідентифікації. Якщо не вказано, вважається, що сесія вбудована в iframe.	`null`	<string>
`language`	Код мови інтерфейсу користувача. Підтримувані значення: `"es", "ka", "uk", "ru", "uz", "it", "gr", "tr", "ro", "ar", "de", "pl", "hi", "bn", "az", "ja", "pt", "fr", "kk", "sv"`	`"en"`	<string>
`skip_desktop`	Обмежує сесії лише мобільними пристроями. Якщо ініційовано на комп'ютері, відображається QR-код для перенесення сесії на мобільний пристрій.	`false`	<boolean>
`switch_device_url`	Користувацький URL для відображення в QR-коді, якщо камера недоступна або заблокована. Якщо URL не вказано або поле залишено порожнім, QR-код не відображатиметься.	`null`	<string>
`restrict_url_sharing`	Забороняє використання URL-адреси сесії в іншому браузері або на іншому пристрої. Якщо встановлено `true`, QR-код не відображатиметься, коли доступ до камери заборонено, якщо не вказано `switch_device_url`.	`false`	<boolean>
`requiredHdMedia`	Вимагає використання камери Full HD (1080p+) для кроків `liveness` та `identity-document`. Якщо не виконано, показується QR-код для переходу користувача на інший пристрій.	`false`	<boolean>

Властивість	Опис
`type`	Тип конкретного кроку (див. список підтримуваних типів кроків нижче).
`key`	Унікальний ідентифікатор кроку. Цей ключ можна налаштувати, але він має залишатися унікальним у межах сесії.
`flags`	Прапорці конфігурації, специфічні для кроку, які контролюють поведінку цього кроку.
`title`	Користувацький заголовок, наданий клієнтом, що відображається користувачеві під час цього кроку в інтерфейсі.

Прапорець	Опис	За замовчуванням	Тип
`disable_document_capture`	Вимикає живе сканування документа. Користувачі можуть лише завантажувати зображення своїх документів.	`false`	<boolean>
`allow_document_upload`	Вмикає опцію сканувати або завантажувати документ.	`false`	<boolean>
`allow_nfc_capture`	Вмикає зчитування NFC-чипа для підтримуваних документів, що посвідчують особу (наприклад, біометричні паспорти та ID-картки). Коли увімкнено, користувачі можуть сканувати NFC-чип документа за допомогою сумісного пристрою.	`false`	<boolean>
`document_types`	Список дозволених типів документів. Можливі значення: `"id", "passport", "driver_license", "residence_license"`	Усі типи	Array<string>
`document_countries`	Обмежує прийнятних видавців документів конкретними кодами країн (наприклад, `"USA", "DEU", "ITA"`).	Без обмежень	Array<string>
`optional_continue_on_another_device`	Дозволяє користувачам за бажанням перейти на інший пристрій, щоб продовжити сесію.	`false`	<boolean>