Skip to content
This repository has been archived by the owner on Nov 14, 2024. It is now read-only.

idfy-io/idfy-sdk-node

Repository files navigation

Idfy Node.js SDK

Build Status npm (scoped)

A Node.js SDK for simple integration with the Idfy REST API.

Installation

npm install @idfy/sdk --save 

Documentation

Sample Usage

All methods return a Promise that resolves with the response body returned from the API.

The example below shows how to get the details of a single document.

const { IdfyClient } = require('@idfy/sdk');

// Initialize client with your credentials and desired scopes
const client = new IdfyClient(
  'clientId',
  'clientSecret',
  ['document_read', 'document_write']
);

// Make a call to retrieve the document
client.signature.getDocument('documentId')
  .then((document) => {
    console.log(`Retrieved document: ${document.title}`);
  });

Typescript Usage

The Idfy SDK comes with built-in typings.

import { IdfyClient } from '@idfy/sdk';

const client: IdfyClient = new IdfyClient(/* ... /*);

Support