# @idfy/sdk

> Node.js SDK for Idfy REST API

Latest version **1.0.0-beta.9** (published 2021-11-22) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @idfy/sdk
pnpm add @idfy/sdk
yarn add @idfy/sdk
bun add @idfy/sdk
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0-beta.9 |
| Published | 2021-11-22 |
| First published | 2018-12-05 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 176.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Idfy Norge AS |
| Maintainers | idfy |
| Keywords | idfy, sdk, api, rest-api, signature, identification |

## Links

- npm: https://www.npmjs.com/package/@idfy/sdk
- Repository: https://github.com/idfy-io/idfy-sdk-node
- Issues: https://github.com/idfy-io/idfy-sdk-node/issues
- npm.io page: https://npm.io/package/@idfy/sdk

## Dependencies (1)

- [got](https://npm.io/package/got.md) ^11.1.4

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.0-beta.9 (latest) — 2021-11-22
- 1.0.0-beta.8 — 2021-07-26
- 1.0.0-beta.7 — 2021-06-21
- 1.0.0-beta.6 — 2021-05-26
- 1.0.0-beta.5 — 2021-05-25
- 1.0.0-beta.4 — 2021-04-27
- 1.0.0-beta.3 — 2020-06-11
- 1.0.0-beta.2 — 2020-06-04
- 1.0.0-beta.1 — 2018-12-07
- 1.0.0-beta.0 — 2018-12-07
- 0.3.0 — 2018-12-06
- 0.2.2 — 2018-12-06
- 0.2.1 — 2018-12-06
- 0.1.0 — 2018-12-05

## README

# Idfy Node.js SDK
[![Build Status](https://travis-ci.com/idfy-io/idfy-sdk-node.svg?branch=master)](https://travis-ci.com/idfy-io/idfy-sdk-node)
[![npm (scoped)](https://img.shields.io/npm/v/@idfy/sdk.svg)](https://www.npmjs.com/package/@idfy/sdk)

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

## Installation
	npm install @idfy/sdk --save 

## Documentation
- [Idfy REST API Reference](https://developer.signicat.com/express/apis/overview.html)
- [Idfy Developer Documentation](https://developer.signicat.com/express/docs/)


## Sample Usage
All methods return a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) that resolves with the response body returned from the API.

The example below shows how to get the details of a single document.
```javascript
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.

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

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


## Support
- Open an [issue](https://github.com/idfy-io/idfy-sdk-node/issues) to report bugs or submit feature requests.
- For other support requests, visit our [support page](https://www.signicat.com/en/contact#support) or contact us at [support@signicat.com](mailto:support@signicat.com).

---
_Source: https://npm.io/package/@idfy/sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._