npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

cordova-plugin-onfido

v1.1.5

Published

Cordova plugin for Onfido

Downloads

19

Readme

cordova-plugin-onfido

This plugin can be used to interact with Onfido native SDK`s through cordova apps.

Installation

Get stable version from npm:

 cordova plugin add cordova-plugin-onfido

Get latest master:

cordova plugin add https://github.com/rewireltd1/cordova-plugin-onfido

Basic Usage

const options = {
     token: 'mobile sdk token here', // IMPORTANT: see notes
     applicant_id: 'applicant id here',
     flow_steps: [ 'welcome', 'document', 'face', 'final'],
}

const onComplete = (completeResponse) => {
    alert(completeResponse)
}

window.cordova.plugins.onfido.init(onComplete, options);

API Reference


onfido

onfido.init(successCallback, options)

Takes options and inits Onfido native SDK

options example:

    {
          token: [mobile sdk token], // SEE NOTES
          applicant_id: [ users applicant id ],
          flow_steps: [
            FlowTypes.Document,
            FlowTypes.Face,
          ],
          // documentTypes: [] // (currently not implmented in Onfido mobile sdks)
    }

FlowTypes options (typescript):

enum FlowTypes {
  Welcome = 'welcome',
  Document = 'document',
  Face = 'face',
  FaceVideo = 'face_video',
  Final = 'final',
}

~~DocumentTypes~~ options (typescript): (currently not implmented in Onfido mobile sdks) :

enum DocumentTypes {
  Passport = 'passport',
  nationalIdentityCard = 'national_identity_card',
  drivingLicence = 'driving_licence',
}

successCallback response:

{
    document: {
        front: {
            id: 'doc id',
            type: 'doc type',
            side: 'doc side'
        },
        back: {
            id: 'doc id',
            type: 'doc type',
            side: 'doc side'
        }
    }
}

NOTES

  • IMOPRTANT: Please note that we are passing the mobile sdk token from javascript but it shouldnt be saved in the javascript bundle! in the javascript code we are making authenticated request to our backend to retrieve it. see TODO`s for other methods

TODO`s

  • Passing mobile token from env variable:
    • Create Cordova hooks that injects Onfido token to config.xml
    • Read token from preferences (how to do that: https://taivo.github.io/guides/read-config-xml-in-cordova)

Credits

  • https://github.com/ihor-zhvanko, we used his code from https://github.com/ihor-zhvanko/cordova-plugin-onfido as a starting point

How to Contribute

Contributors are welcome! And we need your contributions to keep the project moving forward. You can[report bugs, improve the documentation, or contribute code.

Have a solution? Send a Pull Request.