Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
These guides ensure a smooth and secure process for both registering and accessing your account.
Open your web browser and navigate to our website https://allpass.ai/
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:
Full Name
Enter your full name.
Company Name
Enter the name of your company.
Phone
Enter your job title or position within the company.
Position
Enter your contact phone number.
Enter a valid email address. This will be used for login and communication purposes.
Password
Create a strong password. Ensure it meets the security requirements.
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.
Open your web browser and navigate to our website https://allpass.ai/
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.
If you forget your password, click on the Forgot Password? link on the login page. Follow the instructions to reset your password.
If you encounter any issues during the sign-up or login process, ensure all fields are filled correctly and check your email for the verification link. If problems persist, contact our support team.
This guide ensures you can seamlessly expand and manage your team within the platform.
Assigning roles to users is a straightforward process that ensures each team member has the appropriate permissions for their responsibilities.
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 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.
This page provides detailed instructions on how to configure and manage your company's settings
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.
Company Name
Edit the name of your company as required.
Address
Update the physical address of your company.
Phone
Modify the contact phone number for your company.
Update the primary email address associated with your company.
Contact
Edit the details of the primary contact person within your company.
Info
Add or modify general information or notes relevant to your company.
Client Key
Status
Indicates the current status of your company's account
Integration
Displays the type of integration.
Creation Date
Shows the date when your company account was initially created.
Update Date
Displays the last date when any changes were made to your company settings.
Private Client Key
A unique key used for secure API communication between your company's systems and our platform in live mode. This key is generated and managed securely by our system.
Private Client Test Key
Similar to the Private Client Key but used specifically for API communication in test mode. It ensures secure testing of integrations without affecting live data.
The Applications page is where you configure key settings and credentials needed to interact with our Public API and Webhooks. This guide will walk you through creating and managing applications:
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.
Each application contains essential parameters for API authentication, webhook integration, and user redirection:
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.
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.
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
In the Application Details section, locate the Redirect URL field.
Enter the URL where applicants should be redirected after verification (e.g., https://www.yourapp.com/success).
Click Save changes to confirm.
After the application is created and saved, the system generates the following unique keys:
Purpose: A unique identifier for your application.
Usage: This ID is used internally within the system to reference your application during API interactions.
Purpose: Used for encrypting and decrypting data exchanged between your application and our services.
Usage: Retrieve this key to securely transmit sensitive data.
You can regenerate the Crypto Key if needed, but this will invalidate the previous key.
Purpose: Required for authentication when interacting with the Public API.
Usage: Include this key in API requests to ensure secure and authorized access.
These keys are generated only after the application is created and saved.
For security reasons, store these keys securely, as they provide access to API functionalities.
The Webhook tab allows you to set up notifications and event tracking for your application.
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.
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
Navigate to the Webhook tab in the Application Settings.
Click Add notifications via webhook to create a new webhook connection.
Enter a Webhook Name and Webhook URL
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.
Click Save changes to apply the configuration.
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.
Navigate to the Webhook tab in the Application Settings.
Scroll down to the Failed Webhook Deliveries section.
Click View Failed Webhooks to open the failure log.
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").
This page provides an in-depth look at how to efficiently move through our platform, ensuring you can find and use all features effortlessly.
The Header is located at the top of almost every page on the platform and provides quick access to essential features and information.
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.
The Account Settings section allows you to manage your personal information and language settings, ensuring your profile and preferences are up-to-date.
This page explains how to manage access control within the platform
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.
This page explains the differences between Test Mode and Live Mode for you to learn how and when to switch between them.
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 Modeis 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.
Test Mode is available to all users through registering on our website. No prior subscription is required to access this mode
Live Modeis 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.
Live Mode is only available to clients who have signed the agreement and selected a pricing plan. Afterwards, access to Live Mode can also be restricted by assigning the respective user roles .
You can switch between Test Mode and Live Mode at any time through the toggle in the header:
Data created and collected in Test Mode is not transferred to Live Mode automatically. However, Workflows can be duplicated manually if needed. For more instructions follow the link.
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.
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:
The activation code for Telegram will only be generated once the settings are saved and reopened in the Edit mode.
Once the notification channels are configured, click Save to apply the changes.
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.
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.
