Node.js pasby™ library

The pasby™ node library provides convenient access to the pasby API from applications written in Typescript/Javascript.

Our integrations supercharge your digital services and drastically improves your user experience flows.

Requirements

Node 10 or higher.

Installation

npm i @finsel-dgi/pasby

pnpm i @finsel-dgi/pasby

yarn add @finsel-dgi/pasby

Usage

The package needs to be configured with your account's secret key, which is retrievable from the developer Console. Provide it with your organisations api key.

import { Pasby } from "@finsel-dgi/pasby";

const pasby = new Pasby({
  apikeyAuth: 'bk-test_',
  appSecretKey: 'snb_',
  basePath: "https://s.pasby.africa"
});

await pasby.flows.ping('req_')
.then((value) => {
  console.log(`${JSON.stringify(value)}`);
});

or using production access:

import { Pasby } from "@finsel-dgi/pasby";

const pasby = new Pasby({
  apikeyAuth: 'bk-live_',
  appSecretKey: 'prd_',
  basePath: "https://l.pasby.africa"
});

await pasby.flows.ping('req_')
.then((value) => {
  console.log(`${JSON.stringify(value)}`);
});

Documentation

See our REST API docs

See integrations guide documentation covering how to use the library and pasby in general.

Start integrating today at no costs and only begin to pay once you cross 100 requests monthly. We look forward to see what you build with on pasby™.

Learn how to integrate pasby™ through this demo application with open source code.

Document Operations

Document Signature Refresh

Refresh document signatures using the flow identifier:

// Refresh document signatures
const refreshResult = await pasby.docs.docSignatureRefresh({ 
  flow: 'your_flow_identifier_here' 
});

console.log('Document refreshed:', refreshResult.data.doc.id);
console.log('Status:', refreshResult.status);
console.log('Reason:', refreshResult.reason);

The response includes comprehensive document information including signees, signatures, file details, and status logs.