Giter Club home page Giter Club logo

appruve's Introduction

Appruve

NPM Version Build Status

A NodeJS Wrapper for Appruve

Overview

This project provides an easy-to-use object-oriented API to access endpoints delineated at https://docs.appruve.co

Getting Started

Install from the NPM Registry

    $ npm i --save appruve

Usage

let Appruve = require('appruve')

let APIKEY = 'sk_live_2hWyQ6HW73jS8p1IftJRKxDkXmSWOlE4y9Inhgyd6g5f2R7'
const environment = process.env.NODE_ENV

const appruve = new Appruve(APIKEY, environment)


// Verify a Nigeria Driver License ID

const promise1 = appruve.nigeriaDriverLicense({
  id: 'ABC00578AA2',
  first_name: 'Henry',
  last_name: 'Emeka',
  date_of_birth: '1976-04-15'
})

promise1.then(function(response){
   // Error Handling
   if(response.body.status === false){
     console.error(response.body.message);
   }
   let data = response.body;
}).catch(function (error) {
  // deal with error
})

// Verify a Ghana International Passport.

const promise2 = appruve.ghanaPassport({
  id:'G0000000'
})

promise2.then(function(response){
  var data = response.body
  
}).catch(function(error){
  // deal with error
})

API Resources

Each method expects an object literal with both route parameters and request parameters (query / body). Please, go through the src/endpoints folder to see the specific items that should make up the object literal for each method

  • identity

    • appruve.nigeriaNationalId() DEPRECATED
    • appruve.nigeriaVoterId()
    • appruve.nigeriaDriverLicense()
    • appruve.nigeriaBVN()
    • appruve.nigeriaPassport()
    • appruve.kenyaNationalId()
    • appruve.ugandaTelco()
    • appruve.ghanaPassport()
    • appruve.ghanaSSNIT()
    • appruve.ghanaDriverLicense()
    • appruve.nigeriavNIN()
  • business

    • appruve.nigeriaCAC()
    • appruve.nigeriaTIN()
    • appruve.ghanaTIN()
    • appruve.kenyaKRA()
  • Agency

    • appruve.validateBVN()
    • appruve.verifyBVN()

License

MIT

Credits

Support

Coolcodes is a non-profit software foundation (collective) created by Oparand - parent company of StitchNG, Synergixe based in Abuja, Nigeria. You'll find an overview of all our work and supported open source projects on our Facebook Page.

Follow us on facebook if you can to get the latest open source software/freeware news and infomation.

Does your business depend on our open projects? Reach out and support us on Patreon. All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.

appruve's People

Contributors

devamaz avatar hallydon avatar saeenab avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.