Sumsub SDK

Appearance

Sumsub SDK ​

A NodeJS SDK for interacting with the Sumsub API

LicenseDocumentation
LicenseDoc Coverage Badge

Versioning ​

In order to allow for fast releases and bug fixes, every commit and version are published to the package registry. Production-ready releases are versioned using the standard semvar versioning, while development builds are versioned using the following scheme: 0.0.0-%%branch%%-%%commit hash%%. This allows for easy identification of the commit that was used to build the package, and allows for easy upgrades to newer versions, while preventing unstable versions from clashing with stable versions.

Installation ​

npm ​

First, add the registry for the package to your project's .npmrc file. You can do this by running the following command:

bash
echo @nht-subsub:registry=https://gitlab.com/api/v4/projects/55518657/packages/npm/ >> .npmrc

or just add the following to your .npmrc file.

text
@nht-subsub:registry=https://gitlab.com/api/v4/projects/55518657/packages/npm/

Then, install the package:

bash
npm i @nht-subsub/sdk@^1.20240304.4

yarn ​

First, add the registry for the package to your project's .yarnrc file. You can do this by running the following command:

bash
echo "\"@nht-subsub:registry\" \"https://gitlab.com/api/v4/projects/55518657/packages/npm/\"" >> .yarnrc

or just add the following to your .yarnrc file.

"@nht-subsub:registry" "https://gitlab.com/api/v4/projects/55518657/packages/npm/"

Then, install the package:

bash
yarn add @nht-subsub/sdk@^1.20240304.4

Usage ​

Typescript / ES6 ​

typescript
import SumsubClient from '@nht-subsub/sdk'
const client = new SumsubClient('{api token}', '{api secret}')

CommonJS ​

javascript
const SumsubClient = require('@nht-subsub/sdk')
const client = new SumsubClient('{api token}', '{api secret}')

For more information, see the API documentation