Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

sumsub-node-sdk

agiodigital-owner3.3kISC1.1.7TypeScript support: included

SumSub Node SDK for JavaScript/TypeScript

SumSub, SumSub Node SDK, SumSub Node SDK for JavaScript, Identity Verification, Typescript

readme

Sumsub Node SDK

Description

https://developers.sumsub.com/api-reference

This SDK wraps the official SumSub API into an easy-to-use, strongly-typed Javascript and Typescript SDK.

Install

npm install sumsub-node-sdk

or

yarn add sumsub-node-sdk

Example setup

import { sdk } from "sumsub-node-sdk";

// Instantiate the SDK 
const sumsub = sdk({
  baseURL: process.env.SUMSUB_BASE_URL,
  secretKey: process.env.SUMSUB_SECRET_KEY,
  appToken: process.env.SUMSUB_APP_TOKEN,
});

// Use the methods
const { data } = await sumsub.createApplicant("my-external-user-id", "basic-kyc-level", {
  email: "user@gmail.com",
  phone: "+1234567890",
  fixedInfo: {
    country: "USA",
  },
  metadata: [
    {
      key: "foo",
      value: "bar",
    },
  ],
});

console.log(data.externalUserId)
// "my-external-user-id"

More examples

/tests/sumsub.spec.ts

Build from source

npm run build

Run tests

npm run test

Contact

dev@agiodigital.com