liveness-plugin-cordova

Guardian Liveness Detection SDK Cordova plugin.

Installation

npx cordova plugin add liveness-plugin-cordova

Usage

The plugin is available under the global cordova.plugins.liveness object once deviceready event has fired. There is no need to import it.

// Assign the plugin to a shorter variable for convenience
var liveness = cordova.plugins.liveness;

// --- Example Flow ---

// 1. Get the SDK version (optional)
liveness.getSDKVersion(
  function(version) {
    console.log('SDK Version: ' + version);
  },
  function(error) {
    console.error('Failed to get SDK version', error);
  }
);

// 2. Initialize the SDK with market selection
var market = liveness.Market.Indonesia; // Use the provided Market enum
liveness.initSDKOfLicense(
  market,
  function() {
    console.log('SDK Initialized Successfully');

    // 3. Set the license key and check if it's valid
    var license = 'YOUR_LICENSE_KEY'; // IMPORTANT: Replace with your actual license key
    liveness.setLicenseAndCheck(
      license,
      function(checkResult) {
        console.log('License check result: ' + checkResult);

        // 4. If license is valid, start liveness detection
        if (checkResult && (checkResult.toUpperCase() === 'SUCCESS' || checkResult.toUpperCase().includes('VALID'))) {
          
          var livenessParams = {
            cameraType: 'FRONT',
            detectOcclusion: false, // Whether to detect occlusion
            auditImageConfig: {
              enableCollectSwitch: true, // Whether to enable the collection switch
              imageWidth: 400, // Image width
              imageQuality: 30, // Image quality
              relativeSecondsCaptureAfterCameraLaunched: 3.0, // Capture at a relative number of seconds after the camera is launched
            },
            livenessType: 'test_more', // Liveness detection type
            signatureId: '', // Signature ID, if available
            distantNearTimeout: 50000, // Timeout for distant-near detection in milliseconds
            silentTimeout: 50000, // Timeout for silent detection in milliseconds
            actionTimeout: 10000, // Timeout for actions in milliseconds
            prepareMillSeconds: 0, // Preparation time in milliseconds
            resultPictureSize: 600, // Result picture size
            maxRecordVideoSeconds: 600, // Maximum video recording time in seconds
            userId: '', // User ID, in JSON string format
            maskColor: '#000000', // Mask color
            ovalColor: '#000000', // Oval color
            ovalNormalColor: '#000000', // Normal oval color
          };

          liveness.startLivenessDetection(
            livenessParams,
            function(result) {
              console.log('Liveness detection result received:', result);
              // Handle success result:
              // result.isSuccess
              // result.livenessId
              // result.base64Image
            },
            function(error) {
              console.error('Liveness detection failed:', error);
            }
          );
        }
      },
      function(error) {
        console.error('Failed to set and check license', error);
      }
    );
  },
  function(error) {
    console.error('SDK Initialization failed', error);
  }
);

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

Apache-2.0