0.0.1 • Published 7 years ago

fullcontact-card-reader v0.0.1

Weekly downloads
2
License
MIT
Repository
github
Last release
7 years ago

fullcontact-card-reader

Build Status Coverage Status npm version Dependency Status License

FullContact Card Reader API Wrapper for Node.js

Install

npm install --save fullcontact-card-reader

Usage

import fullcontact from 'fullcontact-card-reader';

// ...later in your code
const result = await fullcontact.uploadCard({
  // [REQUIRED] default = null
  apiKey: '_YOUR_API_KEY_',

  // [REQUIRED] default = null
  webhookUrl: '_YOUR_WEBHOOK_URL_',

  // [REQUIRED] default = null
  front: '_YOUR_IMAGE_',

  // [OPTIONAL] https://www.fullcontact.com/developer/docs/card-reader/#upload-card
  back,
  verified,
  returnedData,
  format,
  casing,
  sandbox,
  URID,
  customParams,
  callback,
});


const result = await fullcontact.viewRequest({
  // [REQUIRED] default = null
  apiKey: '_YOUR_API_KEY_',

  // [REQUIRED] default = null
  id: '_YOUR_REQUEST_ID_',

  // [OPTIONAL] https://www.fullcontact.com/developer/docs/card-reader/#view-single-request
  returnedData,
  format,
  diagnostics,
  callback,
});


const result = await fullcontact.viewRequests({
  // [REQUIRED] default = null
  apiKey: '_YOUR_API_KEY_',

  // [OPTIONAL] https://www.fullcontact.com/developer/docs/card-reader/#view-requests
  page,
  returnedData,
  format,
  diagnostics,
  callback,
});

License

MIT License