vouched-nodejs v0.0.1-beta.10

vouched-nodejs

Getting Started

Required libraries

vouched-nodejs relies on libvps and python for compressing images before transport. Installation instructions for libvips found at https://github.com/lovell/sharp-libvips.

Installation

If you use npm, simply do: npm install vouched-nodejs. Otherwise, you can grab the code from [GitHub].

Quick start

Here's a very simple server using Vouched for Node.js for authentication

Create the Vouched client

const Client = require('vouched-nodejs').default;
const client = Client(secret_app_key);

Arguments

Returns

Errors

InvalidRequestError

Update client key

const secretClientKey = '<SECRET>'
const data = client.updateSecretClientKey(secretClientKey);

Arguments

Returns

Errors

AuthenticationError ConnectionError InvalidRequestError UnknownSystemError

Submit a verification job

const utils = require('vouched-nodejs').utils;

const userPhotoBase64 = await utils.imageToBase64(
    './tests/data/selfie.png'
);
const idPhotoBase64 = await utils.imageToBase64(
    './tests/data/id.jpg'
);
const job = await client.submit({
    userPhoto:userPhotoBase64,
    idPhoto:idPhotoBase64,
    type:'id-verification',
    firstName:'Janice',
    properties:[
      {name:'internal_id',value:'iid'},
      {name:'internal_username',value:'bob'}
    ],
    dob:'06/22/1990',
    lastName:'Way'
})
      

Arguments

properties - arbitrary properties to add to the job, i.e. application ids

parameters - object for id-verification.

Returns

Errors

AuthenticationError ConnectionError InvalidRequestError UnknownSystemError

Remove a job

const job = await client.remove({ id: 'ofm1k9xF' })

Arguments

Returns

Errors

AuthenticationError ConnectionError InvalidRequestError UnknownSystemError

Provide results on jobs

params := map[string]interface{}{
  "page":       1,
  "sortBy":     "date",
  "sortOrder":  "desc",
  "from":       "1990-12-24T04:44:00+00:00",
  "to":         "2020-12-24T04:44:00+00:00",
  "type":       "id-verification",
  "token":       "SESSION_TOKEN",
  "status":     "active",
  "withPhotos": false,
  "pageSize":   2,
}
if resp, err := c.Jobs(params); err != nil {
  fmt.Printf("Error: %+v
", err)
} else {
  fmt.Printf("Jobs: %+v
", resp)
}

const jobs = client.jobs({
    page:1,
    pageSize:2,
    type:'id-verification',
    status:'active',
    token:<TOKEN_FROM_WEB_CLIENT>,
    sortBy:'date',
    sortOrder:'desc',
    withPhotos:true,
    fromDate:'2017-01-24T04:44:00+00:00',
    toDate:'2020-12-24T04:44:00+00:00'
})

Arguments

Returns

Errors

AuthenticationError ConnectionError InvalidRequestError UnknownSystemError

Types

Errors

type

InvalidRequestError - The request is invalid. FaceMatchError - Face match felled below the threshold NameMatchError - Name match felled below the threshold BirthDateMatchError - Birth date match felled below the threshold InvalidIdPhotoError - The ID is invalid InvalidUserPhotoError - The user photo (selfie) is invalid UNAUTHENTICATED/AuthenticationError - The request could not be authenticated ConnectionError - A connection error occurred while communicating to the Vouched service InvalidIdBackPhotoError - The back of the ID is invalid UnknownSystemError - A unknown system error occurred InvalidIdError - The ID is invalid

Job

request

result

Confidences

JobParameters

Testing

Run the tests:

yarn test

Run a specific test file:

yarn test -- 'utils.test'

Run a specific test scenario:

yarn test -- 'utils.test' --t 'toImage - success'

yarn test -- 'client.test' --t 'submit - success'