Skip to content

Installing SDK

Welcome to our identity validation integration guide. This documentation provides detailed instructions on how to integrate our identity validation system into your application using our SDK. The system enables secure and efficient user identity verification directly within your application, enhancing user experience by eliminating the need for external redirects.

Our identity validation process includes:

  • OCR Document Validation: Verifies the authenticity and details of the user's document.
  • Liveness Detection: Ensures the user is physically present during the validation.
  • Facematch Verification: Compares the user's selfie with the photo on their document.

At the end of the validation process, your system will receive a webhook notification. You can then retrieve detailed validation results using our API.

Installing the lib

Check out an example of installing the lib with npm or yarn, or cdn.

Run 

npm install @paag-io/sdk-identity-validation

or

yarn add @paag-io/sdk-identity-validation

or 

<script src="./dist/sdk-identity-validation.umd.development.js"></script>

Configuration

The iframe is dynamically created with the following permissions and settings:

  • Automatic permissions for camera and microphone.
  • Uses sandbox restrictions to enhance security.
  • For full-screen iframes, it uses position: fixed in the CSS, covering the entire screen.

Params:

  • host: The URL of the validation service (e.g., https://your-validation-host.com). To obtain the url, please contact our support team.
  • token: The token to access the validation service. To obtain the token, please contact our support team.
  • target: (Optional) The HTML element where the iframe will be embedded. If not provided, the iframe will take up the entire screen.

Instantiation Example

import IdentityValidation from '@paag-io/sdk-identity-validation';

const identityValidation = new IdentityValidation({
  host: 'https://your-host-of-validation.com',
  token: 'your-token',
  // target: document.querySelector('#target-element'), // Opcional
});

Available Methods

Check methods available in the next section.