Prembly-vue NPM

IdentityKYC Vue Component

This is a Vue.js component for integrating the IdentityKYC verification service into your web application. It provides an easy way to verify user identities using the IdentityKYC service.

Installation
Usage
API
Example
Contributing
License

Installation

You can install the IdentityKYC Vue component via npm:

include the prembly loader

<script src="https://js.prembly.com/v1/inline/loader/src/loadingOverlay.js"></script>

in your index.html in your public folder.

npm install prembly-vue --save

Usage

Once installed, you can use the IdentityKYC Vue component in your Vue.js application as follows:

import prembly-vue into your project as follows:

<script>

import IdentityKYC from "prembly-vue";

export default {
created() {
  this.initiateWidget();
},

methods: {
  initiateWidget() {
      const indentifyVerifier = IdentityKYC();
      indentifyVerifier.verify({
        merchant_key: 'your_merchant_key',
        first_name: 'John',
        last_name: 'Doe',
        email: 'johndoe@example.com',
        user_ref: "23957429385729",
        config_id: "2b9c65d1-aef6-40ff-aeba-23148a03320c",
         // Add more parameters as needed
        callback: function (response, data) {
          // Handle the verification result here
          if (response.status === 'success') {
            // Verification succeeded
            console.log('Verification succeeded', data);
          } else {
            // Verification failed or was canceled
            console.error('Verification failed', response);
          }
        }
      });
    },
}
}
</script>

Listen for verification events by providing a callback function in the callback parameter. This function will be called when the verification process is complete.

Configuration You can customize the behavior of the IdentityKYC SDK by passing various parameters when calling the verify method. Refer to the official documentation for detailed information on available parameters and options.

API

verify(params)

Initiates the identity verification process.

params (Object): An object containing the following parameters:
merchant_key (String, required): Your merchant key.
first_name (String, required): First name of the user.
last_name (String, required): Last name of the user.
email (String, required): User's' email address.
image (String, required): Base64-encoded user image.
user_ref (String): User reference ID (optional).
config_id (String, required): Your configuration ID.
callback (Function, required): Callback function to handle the verification results.

Examples

IdentityKYC.verify({
  merchant_key: 'YOUR_MERCHANT_KEY',
  first_name: 'John',
  last_name: 'Doe',
  email: 'john.doe@example.com',
  image: 'base64_encoded_image',
  user_ref: '12345',
  config_id: 'YOUR_CONFIG_ID',
  callback: verificationCallback,
});

Check out the examples directory in this repository for sample code and usage scenarios.

Support and Documentation For detailed documentation and support, please visit the Prembly Developer Portal .

👤 Author1 Ikechukwu