Allpass.ai
HomeWeb SiteTerms of ServicesPrivacy Policy
  • Introduction
  • Get Started
    • Sign Up and Sign In
    • Navigation
    • Test and Live Modes
    • Company Settings
    • Application
    • Work With the Team
      • User Roles and Permissions
      • Send Invites and Assign Roles
    • Notifications Settings
  • Build Verification Flows
    • Flow Builder Overview
    • Verification Steps
      • Intro
      • Document Check
      • Liveness
      • Facematching
      • Selfie With a Document
      • Email Verification
      • Phone verification
      • AML
      • Crypto Transaction and Wallet Check
      • Questionnaire
      • Final Screen
    • UI Customization
    • Duplicate Workflows
    • Workflow Drafts
    • Questionnaire Builder
  • Verify Your Users
    • Run Verification Flows
    • Receiving and Completing Verification
    • Restart the Verification Flow
    • Change the Verification Flow
    • Request Additional Information
    • Manual Compliance Check
    • Manual Crypto Transaction and Wallet Monitoring
  • Review Data
    • Verification Status
    • Review Process
    • Applicant Profile
      • Document Check
      • Liveness
      • Facematch
      • Selfie with the document
      • Email Verification
      • Phone Verification
      • AML check
      • Crypto Transaction and Wallet Check
      • Questionnaire
      • IP and Geo Data
    • Applicant Timeline
    • Deactivating and Activating Verification Results
    • Applicant Profile Deletion
  • Download Reports
  • Analytics Dashboard
  • Integration
    • Overview
    • Get Started
    • How to use
    • Installation
    • Initialize
    • Render
    • Webhooks
      • Applicant Webhooks
      • Webhook Timestamp Validation Requirement
    • Open API
    • Dictionary
      • Enums
      • Entities
      • Term & Abbreviations
      • Supported Countries & Documents
    • Encryption
  • TROUBLESHOOTING
    • IP Address Detected as VPN
    • Incomplete User Verification Flows
Powered by GitBook

© 2024 Allpass.ai by elKYC OU. All rights reserved

On this page
  1. Integration

Initialize

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.

Method that is being called once a verification flow is loaded. You can use this to show your own loader and then show div allpass.

Method that is being called once a user starts the verification flow. appKey: API Key transactionId: UUID of the verification. You can use this to query our API.

externalUserId: External user ID (user ID in your system) flowId : Workflow ID mode : Live or Test mode

Method that is being called once a user starts the verification flow, but the verification is not completed

appKey: API Key transactionId: UUID of the verification. You can use this to query our API.

externalUserId: External user ID (user ID in your system) flowId : Workflow ID mode : Live or Test mode

Method that is being called once a user pass any step of the verification flow.

stepType:The step can be one of the following

"intro" | "biometry" | "documents" | "scan" | "diia" | "complete"

appKey: API Key transactionId: UUID of the verification. You can use this to query our API.

externalUserId: External user ID (user ID in your system) flowId : Workflow ID mode : Live or Test mode

Method that is being called once the verification is completed.

appKey: API Key transactionId: UUID of the verification. You can use this to query our API.

externalUserId: External user ID (user ID in your system) flowId : Workflow ID mode : Live or Test mode

error: The reason why the flow failed.

stepType:The step where the error occurred, can be undefined or one of the following

"intro" | "biometry" | "documents" | "scan" | "diia" | "complete" appKey: API Key transactionId: UUID of the verification. You can use this to query our API.

externalUserId: External user ID (user ID in your system) flowId : Workflow ID mode : Live or Test mode

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}) => {},
});

If user doesn't finish verification process and current session is still active - we can automatically start this verification. In order to make it you should call restart after init method.

Allpass.restart();

Also it could be chaining with an init method:

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

PreviousInstallationNextRender

Last updated 9 months ago

let onLoad: () => void;
let onStart: (event: {
  appKey: string;
  transactionId: string;
  externalUserId: string;
  flowId: number;
  mode: 'LIVE' | 'TEST';
}) => void;
let onRestart: (event: {
  appKey: string;
  transactionId: string;
  externalUserId: string;
  flowId: number;
  mode: 'LIVE' | 'TEST';
}) => void;
let onPassStep: (event: {
  appKey: string;
  transactionId: string;
  stepType: string;
  externalUserId: string;
  flowId: number;
  mode: 'LIVE' | 'TEST';
}) => void;
let onComplete: (event: {
  appKey: string;
  transactionId: string;
  externalUserId: string;
  flowId: number;
  mode: 'LIVE' | 'TEST';
}) => void;
let onError: (event: {
  appKey: string;
  transactionId: string;
  error: string;
  stepType?: string;
  externalUserId: string;
  flowId: number;
  mode: 'LIVE' | 'TEST';
}) => void;