cac-verify v2.1.0

CAC VERIFY

CAC VERIFY is a Nodejs package that enables developers search and verify if a company is registered in Nigeria under the Corporate Affairs Commission.

What can I do?

• Search for a list of companies with a search query
• Check if a company is verified by inputting it's RC number.

Getting Started

Installation

To use cac-verify in your project, run:

npm i cac-verify
# or "yarn add cac-verify"

Usage

import { searchCompanies } from 'cac-verify';

/**
 * search for a company
 */

const { success, data, error } = await searchCompanies(query: string)

// response onSuccess
  {
    success: true,
    data: [
      {
        email: string | null;
        active: boolean;
        registrationApproved: boolean;
        natureOfBusinessName: string | null;
        approvedName: string;
        rcNumber: string | null;
        registrationDate: string | null;
        businessCommencementDate: string | null;
        classification: string;
        city: string;
        lga: string;
        state: string;
        address: string;
      }
    ],
    error: null
  }

// response onError
  {
    success: false,
    data: null,
    error: string;
  }



/**
 * check if a company is verified
 */
const { data, error } = await verifyCompany(rcNumber: string)

// response onSuccess
  {
    data: {
      rcNumber: string;
      name: string;
      address: string;
      dateOfRegistration: string;
      isRegistrationComplete: boolean;
    },
    error: null
  }

// response onError
  {
    data: null,
    error: string;
  }