Have ideas to improve npm?Join in the discussion! »

    @complycube/api
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.0 • Public • Published

    ComplyCube Node.js Library

    The official Node.js library for integrating with the ComplyCube API.

    ComplyCube enables you to effortlessly automate your AML/KYC workflows.

    Documentation can be found at https://docs.complycube.com.

    Installation

    Using npm:

    npm install @complycube/api

    Using Yarn:

    yarn add @complycube/api

    Getting Started

    Require the package:

    const { ComplyCube } = require("@complycube/api");

    Configure with your API key:

    const complycube = new ComplyCube({
      apiKey: process.env.COMPLYCUBE_API_KEY
    });

    Using with async/await (in an async function):

    try {
      const client = await complycube.client.create({
        type: "person",
        email: "jane.doe@example.com",
        personDetails: {
          firstName: "Jane",
          lastName: "Doe"
        }
      });
    
      const check = await complycube.check.create(client.id, {
        type: "standard_screening_check"
      });
    
      return check;
    } catch (error) {
      if (error instanceof ComplyCubeApiError) {
        // An error response was returned by the ComplyCube API.
        console.log(error.message);
        console.log(error.type);
      } else {
        console.log(error.message);
      }
    }

    Using with promises:

    complycube.client
      .create({
        type: "person",
        email: "jane.doe@example.com",
        personDetails: {
          firstName: "Jane",
          lastName: "Doe"
        }
      })
      .then(client =>
        complycube.check.create(client.id, {
          type: "standard_screening_check"
        })
      )
      .then(check =>
        // Handle successfully created check.
      )
      .catch(error => {
        // Handle error.
      });

    Response format

    All responses will be JavaScript objects.

    const client = await complycube.client.create({
      type: "person",
      email: "jane.doe@example.com",
      personDetails: {
        firstName: "Jane",
        lastName: "Doe"
      }
    });
    
    console.log(client);
    {
      "id": "<CLIENT_ID>",
      "type": "person",
      "email": "jane.doe@example.com",
      "personDetails": {
          "firstName": "Jane",
          "lastName": "Doe"
      },
      "createdAt": "2020-01-01T00:00:00.000Z",
      "updatedAt": "2020-01-01T00:00:00.000Z"
    }

    More Documentation

    More documentation and code examples can be found at https://docs.complycube.com

    Further information on ComplyCube can be found at https://www.complycube.com

    Install

    npm i @complycube/api

    DownloadsWeekly Downloads

    382

    Version

    1.1.0

    License

    MIT

    Unpacked Size

    126 kB

    Total Files

    25

    Last publish

    Collaborators

    • avatar