What is AllPass.AI?

Allpass.AI is a comprehensive platform designed specifically to streamline and enhance the Know Your Customer (KYC) and Anti-Money Laundering (AML) processes. Our platform offers powerful tools to automate user verification, monitor compliance, and manage regulatory requirements with precision and ease.

No-Code Functionality

One of the standout features of Allpass.AI is its no-code environment, allowing you to easily configure and use the platform without any programming knowledge. This ensures that users can swiftly adapt the platform to their specific needs, reducing the time and effort required to get up and running.

What's Inside This Documentation?

This documentation serves as your guide to fully understanding and utilizing the Allpass.AI platform. Inside, you will find:

• Workplace Functionality Overview: A detailed breakdown of the core features and functionalities available within the Allpass.AI platform, designed to help you manage your compliance tasks effectively.

• Integration Guide: Step-by-step instructions on how to integrate Allpass.AI with your existing systems, ensuring a seamless setup process and optimal performance.

• Web SDK Description: Comprehensive information about our Web SDK, including installation, configuration, and usage details, allowing you to extend and customize the platform to meet your specific needs.

• Dictionary: A comprehensive dictionary of terms used within Allpass.AI, providing clear definitions and explanations to help you navigate the platform with ease.

We hope this documentation will help you navigate and maximize the potential of Allpass.AI. Should you need further assistance, our support team is always ready to help.

Sign Up

• Click on the Sign Up button located at the top right corner of the homepage.

You will be redirected to the sign-up form. Please fill in the following details:

• After filling in all the required fields, click on the Sign Up button at the bottom of the form.

• A verification email will be sent to the email address you provided. Open the email and click on the verification link to activate your account.

• Once your email is verified, your account will be activated. You can now log in to the platform.

Sign In

• Click on the Sign In button located at the top right corner of the homepage.

• You will be redirected to the login form.

• Enter the email address you used and the password you created during the sign-up process.

• Click on the Login button to access your account.

Forgot Password?

• If you forget your password, click on the Forgot Password? link on the login page. Follow the instructions to reset your password.

Assigning roles to users is a straightforward process that ensures each team member has the appropriate permissions for their responsibilities.

New Users

Administrators can easily invite new users by email and assign them roles during the invitation process, as well as manage roles for existing users:

• From the Sidebar Menu, go to the My Team section.

• Select Invites

• Click Create Invite to send an invitation email to the new user:

• Enter the user’s email, choose the role to be assigned and press the Send button:

• The invited user will receive an email with a link to accept the invitation and set up their account.

• Once they accept the invitation, they will be added to the platform with the assigned role.

Managing Existing Users

Managing existing users is essential for ensuring that each team member continues to have the correct permissions as their roles and responsibilities evolve. Administrators can easily update user roles and permissions through the My Team section, maintaining the security and efficiency of the platform.

• From the Sidebar Menu, go to the Users section:

• Select the user whose role you want to update.

• In the user's profile, find the "Role" dropdown menu.

• Select the appropriate role from the dropdown list.

• Click Save to update the user's role.

Managing existing users ensures that your team members have the right access to perform their tasks effectively while maintaining the security and integrity of your platform.

Our Platform offers two distinct modes for users: Test Mode and Live Mode. Understanding the differences between these modes is crucial for effectively utilizing our service. Below is a detailed description of each mode.

Test Mode is designed for users to familiarize themselves with the platform’s features and functionality without the risk of affecting real data. It is ideal for initial testing, training, and experimentation. In Test Mode, you are provided with 5 free verifications. This allows you to test the system and understand how it works without any cost.

Live Mode is intended for actual identity verification processes required for compliance. All verifications performed in this mode are real and affect actual data. Verifications performed in Live Mode are billed according to your subscription plan or pay-per-use agreement.

Switching Between Modes

You can switch between Test Mode and Live Mode at any time through the toggle in the header:

The Company Settings section allows compliance officers to manage important company-related information, ensuring accuracy and relevance.

Below is a detailed description of editable and non-editable fields within Company Settings.

Editable Fields

Non-editable Fields

• You can create new and manage existing applications through the Applications section in Workplace:

• As soon as your application is created you can open it anytime and get the details required for further integration.

Application Configuration Overview

Each application contains essential parameters for API authentication, webhook integration, and user redirection:

Application Name (Required)

• Purpose: The unique name used to identify your application.

• Usage: This field is mandatory and must be filled in when creating an application. Choose a name that clearly represents your application’s purpose.

Description (Optional)

• Purpose: Provides additional context about the application.

• Usage: This field is optional but can be used to store notes or details about the application's purpose, functionality, or integration details.

Redirect URL

• Purpose: Specifies the URL where users will be redirected after completing the applicant flow.

• Usage: This should point to a page in your application where users continue their process after verification.

How to Set the Redirect URL

1. In the Application Details section, locate the Redirect URL field.

2. Enter the URL where applicants should be redirected after verification (e.g., https://www.yourapp.com/success).

3. Click Save changes to confirm.

Encryption Method

• Purpose: Specifies the encryption algorithm used to protect sensitive data associated with a particular application.

• Usage: Choose between AES-256-CBC and AES-256-GCM based on your security and performance needs. This setting helps ensure compliance with security standards and allows you to align encryption preferences with internal policies or partner requirements. - AES-256-CBC – A widely adopted and secure encryption standard, suitable for most use cases. - AES-256-GCM – Offers improved performance and built-in authentication, recommended when additional integrity protection is needed.

Application ID, Crypto Key, and Private App Key

After the application is created and saved, the system generates the following unique keys:

Application ID

• Purpose: A unique identifier for your application.

• Usage: This ID is used internally within the system to reference your application during API interactions.

Crypto Key

• Purpose: Used for encrypting and decrypting data exchanged between your application and our services.

• Usage: Retrieve this key to securely transmit sensitive data.

Private App Key

• Purpose: Required for authentication when interacting with the Public API.

• Usage: Include this key in API requests to ensure secure and authorized access.

Webhook Integration

The Webhook tab allows you to set up notifications and event tracking for your application.

Webhook Endpoint

• Purpose: Defines a Webhook URL where our system will send real-time event notifications about applicant status and other updates.

• Usage: Provide a URL that can handle requests from our system. These notifications help automate workflows and keep your application up-to-date.

Response Headers

• Purpose: Add custom response headers to ensure secure and authenticated communication between your application and the webhook receiver.

• Usage: Multiple headers can be added to support security and other necessary configurations.

How to Configure Webhooks

1. Navigate to the Webhook tab in the Application Settings.

2. Click Add notifications via webhook to create a new webhook connection.

1. Enter a Webhook Name and Webhook URL

1. To add custom headers:

• Click Add response headers

• Enter a Key and Value pair (e.g., Authorization: Bearer <token>).

• Repeat this step to add multiple response headers if needed.

1. Click Save changes to apply the configuration.

Failed Webhook Deliveries

The Failed Webhook Deliveries section provides insights into webhook events that failed due to issues on the client side. This feature helps users identify errors and troubleshoot their webhook configurations.

How to View Failed Webhook Deliveries

1. Navigate to the Webhook tab in the Application Settings.

2. Scroll down to the Failed Webhook Deliveries section.

1. Click View Failed Webhooks to open the failure log.

2. The failure log displays:

   • EVENT_ID – A unique identifier for each failed event.

   • EVENT_TYPE – The type of webhook event (e.g., APPLICANT_COMPLETED, APPLICANT_DUPLICATE_DOCUMENT).

   • ERROR_MESSAGE – A description of why the webhook request failed (e.g., "Expired document").

The Flow Builder is a powerful tool that allows you to design verification workflows by arranging and configuring various verification steps. This feature enables you to tailor the verification process to their specific requirements, ensuring compliance and efficiency.

• From the Sidebar Menu, click on Workflows to open the flow builder interface.

• Click on the Add new button, located at the top right of the Flow Builder page:

A user-friendly interface that allows you to build verification flows by simply dragging and dropping different verification steps into place.

On-demand vs Regular Flows

In our Platform's Flow Builder, you can create two types of verification flows: Regular Flows and On-Demand Flows. Each type serves different purposes and is designed to meet specific verification needs.

Regular Flows are designed for recurring or scheduled verifications that follow a predefined workflow. They are ideal for scenarios where verifications need to be conducted regularly, such as onboarding new users, periodic compliance checks, or ongoing account maintenance.

On-Demand Flows are designed for ad-hoc verifications that are initiated manually as needed. They provide flexibility and control for conducting verifications outside of regular schedules or predefined workflows.

Geo Settings

This feature allows administrators to manage user access to the verification flow based on their geographical location or IP address. Users from restricted countries can be automatically excluded from the process, ensuring compliance with regulatory or company-specific policies.

• Navigate to the workflow where you want to implement country-based restrictions. In the settings panel on the left side, you'll see an option labeled Countries

• Click the Add Permitted Countries button to specify the list of countries where users are allowed to proceed with the verification flow. Only users accessing the system from these countries will be able to continue.

• Alternatively, use the Add Exclusion Countries button to block specific countries. Users accessing the platform from these countries will not be allowed to proceed with the verification flow.

Flow Auto-Approval

The Auto-Approval feature in the flow builder allows the system to automatically approve or reject verification steps without manual intervention. This functionality can be enabled by toggling the Auto-Approval switch within the step configuration settings.

Enable Auto-Approval: Toggle the switch labeled Auto-Approval to the on position.

Add Verification Steps

Click on the Add step and from the available step options, choose the verification steps you need into the flow canvas:

Each step in the flow can be customized with specific settings and criteria to match your verification needs.

Description of the steps is provided further.

Header

The Header is located at the top of almost every page on the platform and provides quick access to essential features and information.

Sidebar Menu

The Sidebar Menu is positioned on the left side of the screen and offers a structured layout of all the main features and sections of the platform. It remains accessible as you navigate through different pages.

Account Settings

The Account Settings section allows you to manage your personal information and language settings, ensuring your profile and preferences are up-to-date.

This step enables users to upload and verify identity documents as part of the verification process. It ensures that only valid and compliant documents are accepted, providing a secure and efficient method for identity verification.

• Add Document Check step into the flow canvas at the appropriate position in the flow.

• Click on Document Check to open its configuration options:

The Liveness step is designed to verify the presence of a live person during the verification process.

• Add Liveness Check step into the flow canvas at the appropriate position in the flow.

• Click on Liveness Check to open its configuration options:

The User Roles and Permissions functionality allows you to create custom roles for different users within your organization. By specifying access levels for various items in the functionality list, you can ensure that each user has the appropriate permissions for their role. Here’s how it works:

• From the Sidebar Menu, navigate to the My Team section.

• Select Role Management:

• Click on the Add New button:

• Enter a name and a description for the new role.

• You will also see a list of functionalities with corresponding checkboxes.

• Review the list of functionalities and check the boxes for the items you want to grant access to for this role:

• Make sure to tailor the permissions according to the responsibilities associated with the role.

• Once you have selected the appropriate permissions, click on the Save button.

• The new role will now appear in the list of available roles.

The Phone Verification step validates the applicant’s phone number to ensure its authenticity and activity. This step enhances security by confirming that the provided phone number is legitimate and can receive communications, which is essential for preventing fraud.

To add the Phone Verification step:

1. Add Phone Verification: Drag and drop the Phone Verification step into the flow canvas at the desired position within the verification flow.

2. Open Configuration Options: Click on Phone Verification in the flow to access and configure its settings:

These settings allow you to adjust the Phone Verification step according to your security requirements and user experience preferences.

This enhances security by confirming the user's contact information through a one-time password sent to their email. This step helps to ensure that the contact details provided by the user are valid and accessible.

• Add Email Verification step into the flow canvas at the appropriate position in the flow.

• Click on Email Verification to open its configuration options:

These settings allow you to adjust the Email Verification step according to your security requirements and user experience preferences.

Notifications on our platform keep you informed about critical events, updates, and actions related to applicants' verificaiton flows. By configuring notification settings, you can ensure the right individuals or groups stay informed at the right time.

Notification Setup Options

Application Notifications

These notifications are sent to all users with access to a particular application. These notifications are ideal for ensuring consistent communication across your team for a particular activities within the application. To set up notifications:

• Navigate to the Applications tab in the platform.

• Create or Edit an Application.

• Notification settings are located under the Application Name and Description fields in the application setup form:

• Set up notifications for the following channels:

Email: Notifications will be sent to users' email addresses you insert into the respective field:

Webhook: Notifications will be sent to a configured webhook endpoint for integration with other systems.

Slack: Notifications will be delivered to a specified Slack channel. You can add one or more Slack channels:

Telegram: Notifications will be sent to a linked Telegram bot or chat:

• Once the notification channels are configured, click Save to apply the changes.

Role Notifications

Notifications targeted at users assigned to specific roles. Use this to ensure that individuals in designated roles, such as Compliance Officers or Administrators, receive relevant updates. To set up Role Notifications:

• Navigate to the Role Management tab in the platform.

• Create or Edit a Role. Notification settings for roles are available during role creation or editing:

• Set up notifications for the following channels:

  • Email: Notifications will be sent to users' email addresses (users wit the assigned this role).

  • In-App: Notifications will appear directly inside the platform for users with the assigned role:

• Slack: Notifications will be delivered to a specified Slack channel.

• Telegram: Notifications will be sent to a linked Telegram bot or chat.

  • Note: The activation code for Telegram will only be generated once the settings are saved and reopened in the Edit mode.

User Notifications

Individually customized notifications set up for specific users. Perfect for tailoring alerts to an individual’s responsibilities or preferences. To set up Role Notifications:

• Navigate to the My Profile page:

• Open it in Editing mode:

• Set up notifications for the channels. Settings are the same as for the Role:

• Once the notification channels are configured, click Save to apply the changes.

This step compares the user’s face across multiple sources to verify their identity. It is crucial for preventing identity fraud and ensuring the integrity of the verification process.

• Add Face Matching step into the flow canvas at the appropriate position in the flow.

• Click on Face Matching to open its configuration options:

The Intro step welcomes users, explains the verification process, and provides necessary instructions. It is always positioned at the beginning of the flow and is a vital element for guiding users through the verification journey. It is especially useful when the flow includes multiple steps, ensuring users are well-informed and prepared before they begin.

• Add Intro Screen step into the flow canvas at the appropriate position in the flow.

• Click on Intro Screen to open its configuration option

Adding Custom Terms & Conditions and Privacy Policies Links to The Intro Screen

You can customize the Intro Screen in the flow builder by adding your own links to the Terms & Conditions and Privacy Policies. This feature allows users to review and accept these policies during the verification process without requiring you to add additional steps to the workflow.

• In the General tab, locate the Confirmed Links section.

• Add your links and Save changes:

  • Enter the link for your Privacy Policy in the respective field.

  • Enter the link for your Terms & Conditions in the respective field

User Experience:

• Users will see checkboxes on the Intro Screen, prompting them to confirm that they’ve read, understood, and agreed to your company’s Privacy Policy and Terms & Conditions.

• Clicking the linked text (e.g., “privacy policy” or “terms of conditions”) will open the corresponding document for review.

The Thank You step is designed to acknowledge and thank users for completing the verification process. It is always placed at the end of the flow.

• Add Thank You Screen step into the flow canvas at the appropriate position in the flow.

• Click on Thank You Screen to open its configuration options.

It enhances the verification process by requiring users to take a selfie while holding their identification document.

• Add Selfie with a Document step into the flow canvas at the appropriate position in the flow.

• Click on Selfie with a Document to open its customization options.

The Questionnaire Step allows you to gather essential information from users through customized forms. This step can be tailored to include various questions relevant to your compliance process.

• Add the Questionnaire step into the flow canvas at the appropriate position.

• Click on Questionnaire step to open its configuration options.

• Select the desired questionnaire schema from the dropdown menu:

It allows you to align the appearance of the verification flows with your branding preferences. Customize colors, fonts, and button styles effortlessly to match your company's look and feel.

• Open your flow and go to Style tab:

• You can choose a color palette that is applied to pictures and color blocks throughout the verification flow:

• Fonts can be customized using Google Fonts in the following format: fontname @font weight.

• Customize the colors of buttons and button borders to match the branding theme. You can select primary button colors, border, text and hover colors.

• All changes are instantly reflected in a real-time preview:

• Click on the icon buttons at the bottom of the screen to navigate between different steps in the verification workflow:

• The main display area will update to show the selected step, allowing you to preview and edit its content and settings.

• To apply and save changes, you need to click the Save button:

The AML Step enhances security and compliance by monitoring user profiles for potential money laundering activities. Users have the option to enable or disable ongoing monitoring as needed.

• Add AML check step into the flow canvas at the appropriate position in the flow.

• Click on AML check to open its configuration options.

• Toggle on or off the ongoing monitoring feature.

• Set the periodicity for ongoing monitoring (e.g., daily, weekly, monthly).

The Crypto Wallet and Transaction Monitoring feature enables users to seamlessly track and verify cryptocurrency wallets and transactions. This tool enhances security and compliance by providing robust monitoring capabilities integrated directly into your workflows or accessible through a dedicated interface.

How to Check Wallets and Transactions:

1. Adding to the User Verification Workflow Leverage the Workflow Builder to integrate wallet and transaction checks directly into your user verification process. Follow these steps:

   • Navigate to the Workflow Builder in your dashboard.

   • Select the workflow where you want to include wallet and transaction monitoring.

   • Add the Transaction monitoring step from the available options:

• Configure the parameters, such as the maximum count of addresses and the list of allowed blockchains:

• Save and activate the workflow to automatically verify wallets as part of the user onboarding or verification process.

The Workflow Builder includes a convenient auto-save feature that ensures your work is not lost if you forget to save manually.

If you create or modify a workflow but do not click the Save button before closing the page, the workflow will automatically be saved as a draft. This functionality helps prevent data loss and allows you to continue your work seamlessly at a later time.

• To continue working on a draft workflow, simply navigate to your list of workflows and locate the ones marked as "Draft.”

• Click on the draft workflow to open it and continue editing from where you left off.

• Once you have completed your changes, click the Save button to finalize the workflow.

When users receive a verification link, the process is designed to be seamless, user-friendly, and flexible, ensuring a smooth and uninterrupted verification journey. Here’s what happens on the user side when they receive a verification link:

• Users will receive the verification link via the specified communication channel.

• The link redirects them to the verification platform, where the process begins.

• If users need to pause the verification process, they can do so without losing their progress. Upon returning, they can resume the verification from the exact step where they left off, ensuring a smooth and uninterrupted user journey.

• Users can start the verification process on one device, such as a desktop computer, and seamlessly continue on another device, like a mobile phone:

• Users proceed through the various verification steps (e.g., Document Check, Liveness Check, etc.) as defined in the verification flow.

• After completing all verification steps, users reach the page specified in the Redirect URL configured during the creation of the Application.

• The Duplicate option is easily accessible from the workflow management interface:

• In the Duplicate Workflow window, select the status of the duplicate workflow using the toggle switch. You can choose between Test and Live modes:

• This flexibility allows you to move workflows from the testing environment to the live environment seamlessly.

• Once duplicated, the new workflow will appear in your list of workflows with a name given while Duplicating.

• Click on the new workflow to edit and customize it as needed.

The Questionnaire Builder is a powerful tool designed for compliance officers to create custom user surveys and integrate them into the user verification workflow. This functionality enhances the compliance process by allowing the collection of specific information tailored to the organization's needs.

• From the Sidebar Menu, click on Questionnaire to open the flow builder interface. The interface displays all existing questionnaires and provides options to create new ones.

• Users can search for existing questionnaires by name and manage them efficiently.

Create Questionnaire

• The Create questionnaire button allows users to start building a new survey quickly:

• After clicking the Create questionnaire button, you are directed to the Questionnaire Builder interface, which consists of three main sections: Designer, Preview, and Logic:

• You can click the Add Question button to start building their questionnaire.

• Fill in the necessary details such as the questionnaire name, and description.

• You can drag and drop various question types from the toolbox into the survey area. This includes multiple-choice, text input, date selection, and more.

• After adding a question, users can customize it by setting the question text, adding options for multiple-choice questions, and setting validation rules (e.g., mandatory responses).

Preview Questionnaire

• The Preview tab allows users not only to see how their questionnaire will appear to respondents, but also test how it works by inserting the answers. This helps in ensuring that the questions are formatted correctly and the survey flows logically.

Create Own Logic

• In the Logic tab, you can set up conditional logic to control the flow of the questionnaire based on respondents' answers. This can include showing or hiding questions based on previous responses, making certain questions mandatory, and branching the survey into different paths.

• You can click the Add New Rule button to start building the logic of questionnaire.

• Select a question whose answer should be checked and a logical operation from the corresponding drop-down menus.

• Then, specify the answer that applies the rule. Some logical operations do not need an answer (for example, Empty or Not empty).

• If the rule needs more than one condition, click the Add Condition button. You can use the AND or OR logical operator to combine the new and previous conditions.

• Conditions that you specify in the UI are converted to logical expressions. If you prefer to enter the expressions directly, click the Manual Entry button on the Toolbar.

• Select one of the following actions from the drop-down menu:

• Click a rule to expand it and use UI elements to edit the rule. Click Done to save your changes.

There are two ways to run verification flows on our Platform: integrating the flow into your application using API webhooks and manually generating a verification link in the workplace. Here's how each method works:

Integrate the Flow into Your Application This method allows you to seamlessly verify user identities as part of your onboarding or compliance process using API webhooks. It's ideal for verifying your entire user base.

• Navigate to the API Keys section under Company to retrieve your API keys.

• Before deploying, test the integration to ensure the verification flow works seamlessly within your application.

• Use the Test Mode to perform verifications without consuming your live verification quota.

Generate a Verification Link Manually This method allows you to generate a verification link manually within the workplace for testing or single verifications.

• From the dashboard, click on Applicants in the Sidebar Menu.

• Click on New Verification

• Fill in the required details for the verification process:

• Click on Create and the verification link will be created and displayed.

• Copy the generated link and send it to the user via email or any other communication channel.

As a compliance officer, you have the capability to restart a verification flow for an applicant if needed. This can be particularly useful if the initial verification flow was not completed successfully.

Here’s how to manually change and restart a verification flow for a user:

• Navigate to the Applicants section from the Sidebar Menu.

• Within the applicant's profile, locate the Flow Tracker.

• Click the Generate Link button

• This will create a unique link to the current verification flow, which you can copy and send to the applicant for them to continue the process.

Overview

• From the Sidebar Menuclick on Verifications and go to Applicants tab:

• Click on the Applicant to open the profile and see the details. The table view offers a clear and concise summary of applicant information:

As illustrated in the screenshot, this view is organized into several key sections:

1. Applicant Header

Applicant Name and Status: Displays the applicant's full name and the current status of their verification.

Profile Picture: Provides a visual identification of the applicant.

External User ID: A unique identifier specific to this applicant within your system.

Reviewer Assignment: Shows the currently assigned reviewer. The reviewer can be changed using the dropdown menu.

Approve/Decline Options (in case the reviewer is assigned): Allows the reviewer to either approve or decline the applicant’s profile based on the verification results.

1. Info and Comments Tabs

Info Tab: Displays key applicant details organized into several categories:

• Applicant IDs: Includes the External User ID and Applicant ID for tracking and integration purposes.

• Personal Info: Lists the applicant's date of birth, location, and IP address. Additional fields like email and telephone number may also be displayed.

• Verification Info: Contains the date and time of the application, the platform used (e.g., WEB), and the current status of the application.

• Device Info: Shows details about the device used during the application process, including location data (Latitude, Longitude), browser type, version, and user agent string.

Comments Tab: A section where reviewers can add and view notes or comments related to the applicant's profile.

1. Verification Tracker

Tracker: A visual progress bar showing the stages of the verification process, such as Document Check, Liveness, Selfie Capture, and Face Match. The progress tracker helps reviewers quickly assess which steps have been completed and which are pending or failed.

1. Verification Steps Details

These sections allow the reviewer to delve into specific verification tasks, providing detailed insights into the results of each step.

Description of each section is provided in the next chapters.

The Request Additional Information feature allows compliance officers to gather extra details from applicants without disrupting the regular verification flow.

Here’s how to request additional data from a user:

• Navigate to the Applicants section from the Sidebar Menu.

• Search for and select the applicant whose verification flow you want to restart.

• Once in the applicant's profile, locate the drop-down list for verification flows within the Flow Tracker.

• If available, click the Request Additional Information button:

• Fill in the required details for requesting the additional information.

• Create a unique link to the on-demand verification flow, which you can send to the applicant for them to provide the data you require.

As a compliance officer, you have the capability to change a verification flow for an applicant if needed. This can be particularly useful if different verification requirements arise.

Here’s how to manually change and restart a verification flow for a user:

• Navigate to the Applicants section from the Sidebar Menu.

• Search for and select the applicant whose verification flow you want to restart.

• Once in the applicant's profile, locate the drop-down list for verification flows within the Flow Tracker.

• Click on the drop-down list to view available verification flows:

• Select the desired verification flow that you want to assign to the applicant.

• After selecting the new verification flow, the system will automatically update the flow for the applicant.

• The applicant’s status will be changed to reflect that the verification process has been restarted.

The Document Check section within the Applicant Profile provides a detailed view of the applicant’s identification document verification results. This section is crucial for ensuring the authenticity and validity of the applicant's submitted documents. It is also is designed to notify users of any discrepancies or problems that need immediate attention:

Key Warnings

• Document Expiration: At the top of the section, a warning banner clearly states that the document provided has expired. This is a critical alert, as expired documents cannot be considered valid for verification purposes.

• Duplicate Document Warning: The system can also trigger a warning if a duplicate document is detected within the platform. This ensures that no two profiles share the same document, preventing fraud and identity theft. A warning banner will notify the reviewer if a duplicate document is found, prompting further investigation or action.

Document Status

• Valid: at the top of the section, a "Valid" status will be displayed if the document is in order.

• Non-valid: a status signifies that the document fails to meet the required criteria for successful verification.

Data Cross-check

Next to each data field (e.g., Issuing State Code, Document Number, Date of Expiry), there are icons that indicate the results of the cross-checks from various sources (visual zone, MRZ, chip):

• Green Icon: Indicates that the information has been successfully verified across all available sources (visual zone, MRZ, chip) and there is consistency in the data.

• Red Icon: Signifies that the data could not be fully verified or there are discrepancies between the information from different sources.

• Orange Icon: Shows that the cross-check for that particular field was not conducted or is not applicable.

Data Editing

If needed, the user can edit the document data directly within the platform. Each field next to the document information features an edit icon.

By clicking this icon, the reviewer can manually adjust the data, ensuring that any necessary corrections are made before final approval. This feature is especially useful if minor discrepancies or typographical errors are identified during the review process.

Data Fields

The Manual AML Scan allows you to perform targeted searches for individuals or organizations to detect potential financial crime risks. The feature is located in the AML Scan section, accessible from the sidebar menu:

How to Perform a Search Request in the AML Scan Feature:

• From the sidebar menu, click on AML Scan and select Search Page.

• At the top of the search form, select whether you want to search for an Individual or an Organization.

• Fill in the Search Fields: Full Name: Enter the full name of the individual or the organization. Search by Name, by Document or by Identity: You can choose whether to search by full name or an alias. Birth Year or Year Range: If applicable, enter the birth year or a range of years for a more specific match. Match Rate: Define the minimum percentage match rate that the search result should meet (e.g., 80%). Only results that meet or exceed this threshold will be returned. Country: Select the country associated with the individual or organization to narrow down the search.

• If you want a more thorough search that checks additional databases, tick the Deep Search checkbox.

• Click the Scan button to start the search request. The system will scan through PEP, Sanctions, Watchlists, and adverse media databases for any potential matches.

• Once the scan is complete, review the results on the same page or on the Scan Results page to assess potential matches and take further action if needed:

The Scan Result provides you with a detailed overview of any matches found during an AML scan. It includes key functionalities for assessing risk, updating case statuses, and enabling ongoing monitoring.

• Match Status can be updated by the user to classify the result:

• You can activate Monitoring Periodicity for a match, ensuring regular updates and alerts for any new information that may arise about the entity:

• Profile Information displays the matched entity’s key details, including: Name: (e.g., ABIGAÏL DAMASANE).

  Match Source: (e.g., OFAC - Specially Designated Nationals - Treasury).

  Match Type: Shows whether the result refers to an Individual or an Organization and its associated list (e.g., Sanction).

• The Comments section allows users to add internal notes and share information within the team, keeping a record of any actions or decisions related to the case.

• Clicking on the card for any specific match will reveal full details about the scanned entity, providing users with a more comprehensive view to aid in decision-making:

• The Scan Results page provides you with a list of all the cases found:

Conduct manual searches for wallets and transactions via the separate Crypto Monitoring page. Here's how:

• Open the dashboard and locate the Transaction Monitoring tab in the sidebar menu:

• Enter the wallet address or transaction ID in the search bar:

• Review the results, including wallet activity, transaction history, and associated risk assessments:

• You can also review the outcomes of their transaction or address scoring on a separate, dedicated Results Page:

The Entity Explorer page within the Crypto Transaction Monitoring module provides users with a streamlined interface to search for and explore specific entities.

• Enter the desired entity name

• Click Search to retrieve detailed data related to the entity:

• Use the results to conduct further monitoring, generate reports, or trigger compliance workflows as necessary:

The Email Verification results are displayed in the applicant's profile, providing a comprehensive breakdown of validation points for the applicant’s email address. Each validation point includes a status indicator and a brief description of the check performed:

If you disagree with any result, you have the option to deactivate this service for the applicant by moving the data to History.

Verification statuses help track the progress and outcomes of each verification process, providing clear indicators of where each applicant stands in the verification journey.

Here’s a detailed description of all the verification statuses:

The Liveness step is a crucial part of the verification process, designed to confirm that the applicant is a real, live person and not a spoof or fake identity. This step typically involves a video recording of the user performing specific actions, such as blinking or turning their head, to demonstrate liveness. You can find the recording in the Liveness block within the Applicant's profile:

This video serves as proof that the applicant completed the required actions to verify their liveness. While the screenshot only shows a still image, the platform typically allows the reviewer to access and review the entire video to ensure the liveness check was performed correctly.

The facematch step involves a detailed comparison of the two or more images, providing a confidence percentage and a side-by-side visual representation to help users accurately verify the applicant's identity.

At the top of the section, the system displays the percentage of face match, which indicates the confidence level of the match between the two images:

Manual Review

As a compliance officer, you have the ability to manage the applicant review process effectively. Here's how to manually handle the review process for an applicant:

• After the system assigns a Completed status to the Applicant, a reviewer must be assigned to finish the verification process.

• Navigate to the Applicants section from the Sidebar Menu.

• Select a Reviewer from the context menu in the applicants table:

• Select a reviewer from the drop-down list and click Assign:

• You can also assign a reviewer from the Applicant's Profile.

• Open the applicant's profile.

• Locate the reviewer section, select a reviewer from the drop-down list and click Assign :

• The reviewer must review and either Approve or Decline the applicant's data:

Automatic Review

• Nevertheless, a reviewer can be assigned if manual intervention is needed before the user has provided all the data and the system has performed all the checks.

• Also, a manual review may be required in case of system warnings or if the face matching result is less than 85%.

The section prominently displays the selfie with the document captured during the verification process.

The image can be zoomed in for closer inspection by the reviewer:

The date when the selfie was captured is displayed above the image. This timestamp helps ensure that the selfie is recent and relevant to the current verification session.

The Phone Verification results section provides a detailed summary of checks performed on the applicant’s phone number. Each validation point includes a status indicator along with an explanation of the check:

If you disagree with any result, you can choose to deactivate the service for this applicant by moving the data to History.

This section is a critical component of the platform, providing results that indicate whether an individual has been flagged in any sanction or watchlist databases.

• The top part of the section displays a warning banner, indicating in case the individual has been flagged in one or more databases:

• Below the warning, the details of the match are displayed.

• When conducting AML (Anti-Money Laundering) searches, the results may include various tags that help categorize and identify the nature of the matched entities. These tags fall under two main categories: Record Types and List Types. Below is a detailed explanation of each tag to help you interpret the search results effectively:

• At the bottom of the section, a comments area allows reviewers to add notes or observations related to the AML check. This is useful for documenting reasons behind the selected match status or any other relevant details.

• By clicking on the individual's name or the match percentage, the reviewer can open a detailed profile view of the flagged individual:

• To the right of the match details, a dropdown menu allows the reviewer to categorize the match further:

The available options include:

• Unknown: The match status is not yet determined.

• No Match: The reviewer determines that there is no match.

• Potential Match: The system has flagged a potential match, which is the current selection in the screenshot.

• False Positive: The match is determined to be a false positive.

• True Positive: The match is confirmed as accurate.

• True Positive Approve: The match is confirmed, but the reviewer chooses to approve the applicant.

• True Positive Reject: The match is confirmed, and the reviewer decides to reject the applicant based on the match.

The Deactivation option is accessible in all verification steps, including Document Check, Liveness, Selfie Capture, Face Match, AML Check, and more. This ensures that reviewers can maintain control all over the entire verification process.

• When a reviewer identifies an issue or disagrees with the results presented by the verification step, they can deactivate the service instantly. This is done by clicking the Deactivate button located at the top right corner of the respective section:

• Upon deactivation, the platform automatically moves the relevant data to history. This ensures that the data is archived and recorded but no longer actively used in the ongoing verification process:

• If the reviewer decides to reinstate the deactivated data, they can return it from History by clicking the "Activate" button:

How to Use Crypto Wallet and Transaction Check Block

1. Accessing the Applicant’s Page

   • Navigate to the Applicant's page to find the Transaction Monitoring block.

   • This block displays wallet addresses or transaction IDs linked to the applicant, along with their corresponding risk scores and monitoring statuses:

1. Accessing Wallet and Transaction Details

• Click on the wallet or transaction ID in the Transaction Monitoring block to view detailed insights.

• This will open a comprehensive view of blockchain activity, including transaction history, risk factors, and flagged compliance issues:

1. Interpreting Report Details The transaction monitoring report provides comprehensive insights into the sources and uses of funds associated with a monitored crypto wallet. Here's how to interpret key sections of the report:

• Risk scores displayed next to the wallet or transaction ID help gauge the likelihood of suspicious activity:

  • Low Scores: 0-30

  • Medium Scores: 31-69

  • High Scores: 70 - 100

• The Risk Exposure section provides an overview of the risk profile associated with the monitored wallet and its transactions. It breaks down risks into specific categories to help you quickly identify areas of concern related to fund sources, fund usage, and overall transaction behavior:

• Source of Funds section analyzes the origins of the funds received by the monitored wallet. It identifies the risk levels and potential issues linked to where the funds came from. The source of funds allows users to identify potentially risky inflows, such as funds from high-risk or hacked wallets. Clicking on an entity (e.g., Root Tx or Leaf Tx) will open the corresponding details on a separate page for further analysis.

• Use of Funds provides an analysis of how funds leaving the wallet are being used, helping to determine if the transactions align with legitimate activity. It helps to determine if the wallet's activity includes potentially suspicious transfers, such as sending funds to unknown or high-risk entities. Similar to the source section, users can click on the listed entities to access additional details on a separate page.

• Every Entity listed in the report is clickable. Clicking on a name redirects you to a dedicated Entity Details page, where you can view a deeper analysis, and associated blockchain data:

1. Taking Actions

• Use the Deactivate button to move resolved or unnecessary cases to history and stop monitoring.

• Toggle the Monitoring option ON or OFF to enable or disable ongoing observation of a specific wallet or transaction:

You can also take specific actions from the detailed view page:

• Add to Monitoring Use the Add to Monitoring button to include the wallet address in active monitoring. This ensures that any future transactions or changes related to the wallet are tracked for compliance and risk management purposes

• Exporting Data Use the Download button in the top-right corner to generate a report of transaction details and compliance findings for recordkeeping or regulatory submission.

• Refresh Data Click Refresh to update the displayed information with the latest blockchain activity and risk analysis. This ensures you are working with the most up-to-date data.

• Viewing Timeline The Timeline button on the Applicant’s page provides a chronological record of all verification steps and actions taken.

The User Deletion functionality provides you with the ability to remove an applicant’s data from the system.

• To initiate the deletion of an applicant’s profile, the reviewer can select the Delete option from the action menu next to the applicant’s record in the table view:

• Upon selecting Delete, a confirmation dialog appears, as shown in the screenshot. This dialog informs the reviewer that the applicant’s data will be scheduled for deletion and will be permanently removed after a 20-day period:

• The reviewer can either confirm the deletion by clicking Schedule Deletion or cancel the process by selecting Cancel, keep the data.

• The applicant’s profile is not immediately removed from the platform. Instead, it is scheduled for deletion after a 20-day grace period. During this time, the data is marked for deletion but remains recoverable:

• If the reviewer decides to restore the applicant’s profile during the scheduled deletion period, they can do so by selecting the Restore Dataoption from the action menu next to the applicant’s record in the table view:

• If no action is taken to restore the data within the 20-day period, the deletion will proceed automatically, and the applicant’s data will be permanently removed from the platform. Once deleted, the data cannot be recovered, ensuring compliance with data retention policies and regulatory requirements.

The Questionnaire Results section provides access to the applicant's completed questionnaire, which is often used to gather additional information required for the verification process.

This section allows users to review the applicant’s responses and assess any potential risks or compliance issues.

The results are displayed as a link to the completed questionnaire in a downloadable PDF format:

Download button is provided next to the file name, allowing the reviewer to easily access the PDF file. This feature ensures that the questionnaire results can be reviewed in detail, stored, or shared with other team members as necessary.

The reporting functionality in our platform allows compliance officers to generate and download comprehensive reports for each applicant. This feature is crucial for record-keeping, auditing, and sharing verification results with relevant stakeholders. The reports are generated directly from the applicant's profile and provide a detailed overview of all verification steps, changes, and media associated with the applicant.

• To generate a report, navigate to the specific applicant's profile within the platform. This profile contains all the verification data and history related to the applicant.

• In the applicant's profile, locate the Download button, which is typically positioned near the top right corner of the interface. Clicking this button will initiate the process of generating and downloading the report:

The reports are downloaded as a ZIP file, which consolidates all relevant documents and data into a single, easily accessible package. The contents of the ZIP file include:

1. General PDF Report: This PDF file contains all the information available in the applicant’s profile, providing a comprehensive overview of the applicant’s details, verification status, and results.

2. History of Changes: A separate file that documents all changes made to the applicant’s profile, including timestamps and details of the modifications. This is essential for maintaining an audit trail.

3. AML Report: If the applicant underwent an AML (Anti-Money Laundering) check as part of their verification flow, the results are included as a separate file in the ZIP. This file contains details about any potential matches or flags identified during the AML check.

4. Questionnaire Results: If the applicant completed a questionnaire during the verification process, the results are provided as a separate file. This document includes all responses given by the applicant.

5. Media Data: All available media associated with the applicant’s verification are included in the ZIP file. This may consist of: - Liveness Video: A video recording of the applicant completing the liveness check, verifying that they are a live person during the verification process. - Face Photos: Photos captured during the liveness check, selfie and from the identification document. - Document Photos: Images of the identification documents submitted by the applicant.

On the Info tab of the verification dashboard, you can see the user's IP address and device information in the Device Info section:

Key elements displayed include:

• IP Address: The user's public IP address.

• Geolocation Data: A mapped location of the user's IP (e.g., city, region, and country).

• Device Details: Information about the user's browser, operating system, and device type.

Clicking on the IP address or the More link will open a detailed view of the IP properties, geolocation data, and provider details:

The detailed view provides in-depth insights into the user's IP address:

How to Use This Information

• Identify Suspicious Activity: Check for IP addresses flagged as "hosting," "VPN," or "proxy" to detect potential anonymity tools or high-risk behavior.

• Verify User Location: Cross-reference the user's declared location with the geolocation data to ensure consistency.

• Assess Risk Levels: Analyze whether the IP address belongs to a residential ISP or hosting service, as hosted IPs might indicate bot or server activity.

This functionality operates in the background, requiring no user action, and provides a robust layer of security for identity verification processes.

Timeline functionality provides a detailed, chronological record of all actions taken on an applicant’s profile. This feature is essential for maintaining transparency, tracking changes, and ensuring compliance with regulatory requirements. The logs allow compliance officers to review all updates, edits, and actions associated with an applicant's verification process.

• From the Applicant profile, click on Timeline to open the profile changes history:

• The timeline interface displays a series of logs, each entry detailing a specific action taken by an applicant or on the applicant's profile. Each log entry includes the date and time of the action, providing a clear, chronological sequence of events:

How to Read the Timeline (Chronology Explained)

The Timeline in Allpass.ai shows a complete, real-time record of every action taken during a user’s verification journey — from the moment the session starts until it's completed, rejected, or left incomplete.

• The Timeline is presented in reverse chronological order (most recent action at the top).

• Each entry includes:

  • Timestamp (date and time of the event)

  • Event description (e.g., “OTP code sent”, “Email verification completed”)

  • Step status (e.g., “Accepted”, “Incomplete”, “Rejected”)

  • System or user actor (e.g., “Changed by system”, “Initiated by applicant”, or staff member name)

  • Metadata (e.g., IP address, location, browser)

How to Read It Step-by-Step

1. Start from the bottom to see how the verification flow began:

   • You’ll usually see events like:

     • “Applicant profile created”

     • “Verification initiated”

     • “Review status: init”

2. Move upward to follow the user journey:

   • Each step in the workflow will generate one or more logs.

3. Top of the timeline = most recent status

   • The current state of the application is shown here.

What Each Status Means

Understanding Location, Device, and IP Metadata

Each log entry in the Timeline includes technical metadata that helps you understand where, how, and on what device the verification flow was accessed.

What Metadata Is Displayed?

For most events, you’ll see:

• Device & OS Example: Mac OS v10.15.7 / Chrome v113.0.0 → Indicates the operating system and browser used by the applicant.

• IP Address Example: 185.5.252.60 → The public IP address assigned to the user during the session.

• Location Example: Ukraine → Based on geolocation data tied to the IP address (note: this is an estimate).

• “View on map” link → Opens a visual map to help you validate if the user's geographic location aligns with expectations (e.g., not using VPNs or proxies).

How to spot user-side vs. system-side errors

When something goes wrong during a KYC/AML flow, it’s important to know where the failure happened — was it due to the user's input or device? Or did the system itself encounter an issue?

The Timeline provides clues to help you quickly identify whether an error is user-side or system-side, so you can take appropriate action (e.g., follow up with the user, restart a step, or escalate internally).

General Rule of Thumb

• User-side errors = The user failed to complete an action or submitted incorrect/incomplete input.

• System-side errors = The platform or API failed to process something correctly (rare but critical).

User-Side Errors Examples: What to Look For

System-Side Errors Examples: What to Look For

Combined Case Example:

• Email step sent ✅

• No OTP entered ❌

• Review status: Incomplete → This is a user-side issue — most likely they didn’t follow through.

Import library to your web application

Start by adding the minified code to your webpage from the unpkg CDN in your HTML file:

<script
 type="text/javascript"
 src="https://unpkg.com/@allpass/web-sdk"
></script>

Or you can install it via npm:

npm install --save @allpass/web-sdk

And then import it in your code:

import Allpass from '@allpass/web-sdk';

Create Allpass.ai Account

Integrate the Verification Flow

Depending on your requirements, you can integrate Allpass.ai via our client-side SDK.

The client-side integration process can be summarized in 2 steps:

1. Install and import our client-side SDK in your application

2. Initialize SDK and our users will complete a Verification through the Verification flow - on completion, you need to track the Verification in your dashboard in workplace and handle it accordingly via the callbacks (e.g. onComplete function)

Setup Webhooks

if you want to automate the process of KYC Allpass.ai uses webhooks to notify your backend when an event happens in your client-side SDK. Webhooks are useful for asynchronous events like when an applicant completes an Applicant's verification or passes some step. You should specify your backend endpoint url and import public RSA key

Retrieve Data From the API

For security purposes, we recommend you to minimize the Data points stored on your server. That being said, if you need to retrieve information related to an Applicant you can do so via the Allpass.ai API. You can retrieve the following types of data:

• Data points collected and shared during an Applicant (E.g. first name, last name, document number, identity score)

• Metadata related to the Applicant (i.e. user agent, timestamp, user references)

You can either follow the integration guide or watch the integration tutorial that shows the same steps. Please be aware that some property or function names might have slightly changed with newer versions. Make sure to compare your implementation with the latest code snippets here in the documentation.

Features

• Read passport data using a smartphone or webcam

• Doc type identification (Machine Learning)

• Parsing doc data (OCR)

• Document authenticity control (data cross-check from visual zone, chip, MRZ)

• Document ownership checks

• Liveness detection

• Face match

• AML

• Questionnaire

• OTP

• Device verification

• IP verification + geoIP

• Data input automation (into client’s software)

• Web workplace

• And much more

Compatibility

You can pass in different handler functions like the onLoad, onStart, onRestart, onPassStep, onComplete or onError method to handle different events of the verification flow to the init function.

Allpass.init({
  onLoad: () => {},
  onRestart: ({appKey, transactionId, externalUserId}) => {},
  onStart: ({appKey, transactionId, externalUserId}) => {},
  onPassStep: ({appKey, transactionId, stepType, externalUserId}) => {},
  onComplete: ({appKey, transactionId, externalUserId}) => {},
  onError: ({appKey, transactionId, error, stepType, externalUserId}) => {},
});

Allpass.restart();

Also it could be chaining with an init method:

Allpass
  .init({onComplete: ({appKey, transactionId, externalUserId, flowId, mode}) => {}})
  .start(accessToken);

The Dashboard provides a comprehensive view of key metrics, enabling users to monitor applicant progress, verification statuses, and system performance across various dimensions. The dashboard is divided into distinct sections, each designed to offer a quick glance into the platform’s core activities and health.

Key Metrics (Top Bar)

The top section of the dashboard highlights six key application statuses within a selected date range (e.g., Today, Last 7 Days, Last 28 Days):

• Applicants Number: The total count of applicants created.

• Applications in Review: The number of applications currently undergoing verification.

• Applications Completed: The count of fully completed applications.

• Applicants Approved: The number of applications that have been successfully approved.

• Applicants Rejected: The count of applications that were rejected.

The user can filter the data by selecting a specific date range, which will automatically update all displayed information.

Graph: Number of Applicants Created Per Date

This graph displays the daily count of applicants created within the chosen time frame, allowing users to track activity trends, such as peaks and troughs in applicant submissions over time.

Applicant Status Overview

This bar chart shows a breakdown of applicant status across categories:

• Completed: Applicants whose verification process is finished.

• In Progress: Applicants whose verification is ongoing.

• Incomplete: Applicants with incomplete submissions.

• Approved/Rejected: Applicants whose verifications resulted in approval or rejection.

Total Applicant Warnings

This donut chart presents the total number of warnings triggered across all applicants:

• Unresolved: Warnings that are yet to be addressed.

• Resolved: Warnings that have been reviewed and cleared.

Applicants Distribution by Country / Phone Number Origin / Document Origin

This section features a world map highlighting the geographical distribution of applicants based on their country of residence, phone number or document origin. A list on the right shows the top countries with the highest number of applicants, such as Ukraine, Spain, and the United Kingdom, for instance.

Verification Overview

This line chart displays the number of verifications conducted within the selected date range, distinguishing between:

• Successful Verifications: Completed successfully.

• Failed Verifications: Those that did not meet the verification criteria or encountered technical issues during the process.

Failed Verification Stages Overview

This chart illustrates at which stage the verification process failed. It helps users identify common failure points and take corrective action to improve the verification process.

Performance Comparisons

There are three performance charts that provide a comparative analysis:

• Successful Verifications Number Compared by Date Range: This line chart compares the number of successful verifications with the target, showing how close or far it is from reaching the goal.

• Total Verifications Compared by Average Number: Shows how the total number of verifications compares to the platform’s average over a specific period, highlighting if it is above or below target.

• Successful Verifications Number Compared with Failed: This line chart contrasts successful and failed verifications, helping users monitor the success rate.

Successful Services Breakdown

A pie chart provides an overview of the success rate across various verification services:

• Liveness: The percentage of successful liveness checks.

• Questionnaire Results: Successful completion of questionnaires.

• OTP Verification: Verification through one-time passwords.

• Document Check: Completion rate for document verification.

• Face Match: Success rate for facial comparison.

• AML: Success rate for AML (Anti-Money Laundering) checks.

Getting started

Allpass.ai uses webhooks to notify your backend when an event happens in your client-side SDK. Webhooks are useful for asynchronous events like when an applicant completes a Verification or passes any step. You should specify your backend endpoint URL and get your Encryption Keys.

The Allpass webhook request has the same structure as all Allpass responses:

export class ResponseEntity {
  @ApiProperty()
  status: boolean;
  
  @ApiProperty({ example: 200 })
  statusCode: number;
  
  @ApiProperty({ type: String })
  data: string;
  
  @ApiProperty({ example: '2021-08-20T14:52:33.648Z' })
  time: string;

  constructor(data: string) {
    this.status = true;
    this.statusCode = 200;
    this.data = data;
    this.time = new Date().toISOString();
  }
}

Retry failed

During the verification process you will receive webhooks with different types and data.

Allpass Webhook System wait for response with status 200, otherwise the Webhook Retry System is activated after 30 seconds with exponential backoff and 10 attempts.

Method 1: No Code - Creating Verification Through Workplace

1. Navigate to the Applicants Page:

   • Go to the "Verification" section and then select "Applicants."

2. Create a New Verification:

   • Fill in the required details:

     • Application: Choose the relevant application.

     • Flow: Select the desired flow.

     • ExternalUserId: Provide the external user ID (unique userID from your system).

     • Language: Set the preferred language (e.g., lang).

     • Token Lifetime: Specify the token lifetime.

3. Generate Verification Link:

   • After providing the necessary information, our system will generate a link.

   • Share this link with the user to grant them access to the verification process.

Method 2: Automated - Creating Verification Through SDK

To automate the verification process, you can use our SDK. This method involves generating a token on your backend and initializing the SDK with the token as a parameter.

Steps for Automated Verification

1. Create a Token:

const axios = require('axios');

async function createToken() {
    const response = await axios.post('https://billing.elkyc.com/api/public/verification', {
        flowName: 'yourFlowName',
        externalUserId: 'user123',
        ttl: 3600,
        locale: 'uk'
    }, {
        headers: {
            'x-private-app-key': 'yourPrivateAppKey'
        }
    });
    return response.data.accessToken;
}

1. • Use the generated token to initialize the SDK.

   • Pass the token as a parameter when setting up the SDK.

Private Application Key

In order to use the public api you will need to obtain a private key.

You can retrieve your Private Application Key from Applications > Private app key.

Overview

When integrating webhooks, it is mandatory to implement timestamp validation to prevent outdated data from overwriting newer updates. Due to the webhook retry mechanism, which attempts to resend requests in case of failures, there is a possibility that an older webhook event may be delivered after a more recent one.

Potential Issue

If timestamp validation is not implemented, an earlier event may update the system with outdated information, leading to data inconsistency and potential operational issues.

Recommended Implementation

To mitigate this risk, follow these steps when processing webhook events:

1. Validate the timestamp: When receiving a webhook request:

   • Compare the incoming event's timestamp with the most recent processed event timestamp for the given entity.

   • Reject or ignore the event if its timestamp is older than the last recorded update.

2. Use an idempotency mechanism: To further prevent duplicate processing, leverage an idempotency key or store processed event IDs to avoid handling the same event multiple times.

Conclusion

Timestamp validation is essential for ensuring that only the latest webhook events are applied to the system. By implementing this check, you can prevent outdated data from being processed and maintain data integrity even in cases where webhook delivery is delayed or retried.

Introduction

Place the new HTML element where you want the component to render inside the body of your HTML file:

Example

In this chapter you can find all information about data structure, types and parameters description

Web browser data collection

This glossary offers clear and concise definitions for each term, ensuring that developers, data analysts, and privacy compliance officers can confidently navigate the intricacies of user data from the browser.

SDK Version: SDK stands for Software Development Kit. This term refers to the version of the software toolkit or package used to integrate certain features or functions into an application, typically related to data collection and analysis.

• IP (Internet Protocol): An IP address is a unique numerical label assigned to each device connected to a computer network that uses the Internet Protocol for communication. It serves as an identifier for the device's location on the internet.

• Country: This is the name of the user's home country, typically determined based on their IP address. It's useful for understanding the geographic origin of the user.

• Region: Refers to the specific geographical region within a country where the user is located. It can provide more granular information about the user's location.

• EU (European Union): Indicates whether the user is located within a country that is a member of the European Union. This information is important for compliance with EU data protection regulations, like GDPR.

• Timezone: This represents the user's local time offset from Coordinated Universal Time (UTC). It helps in displaying date and time information accurately to the user.

• City: The name of the city where the user is located, often determined using their IP address. It provides further geographical precision.

• Metro: It refers to the metropolitan area or region where the user is located. This can be useful for marketing and demographic analysis.

• Latitude and Longitude (Ll): These coordinates pinpoint the exact geographic location of the user. They are expressed in degrees and are valuable for precise geolocation purposes.

• Area: This typically denotes a more specific geographical area within a city, helping to pinpoint the user's location even further.

• User Agent: The user agent is a string of information that the user's browser sends to websites it accesses. It includes details about the browser and device being used, such as the browser type, operating system, and device model.

• Browser Type: This specifies the category or family of the user's web browser, such as Chrome, Firefox, Safari, or Internet Explorer.

• Browser Version: Indicates the specific version number of the user's web browser. Knowing the version is important for web development and ensuring compatibility with different browser releases.

Document Reader Abbreviations

Here you can find essential terms and acronyms in the realms of technology and document identification.

• MRZ (Machine Readable Zone):

  The Machine Readable Zone is a standardized region within identification documents, such as passports and visas, that contains essential personal and document information in a format that can be easily read and processed by machines. This zone typically includes two lines of characters with specific data elements, including the document holder's name, nationality, date of birth, and passport number.

• RFID (Radio-Frequency Identification) refers to the integration of radio-frequency tags or chips into official identification documents, such as passports, driver's licenses, and identity cards. These RFID tags store encrypted data related to the document holder's identity and can be wirelessly read by authorized RFID readers. Document verification systems equipped with RFID technology enable quick and secure authentication of the document's validity and the identity of the holder.