cac-verify's Introduction

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"

Note: cac-verify, uses Anti-Captcha to solve captcha on the CAC website. So headover HERE to register and receive your API_KEY

Usage

import { initAntiCaptcha, scrapCompanies, verifyCompany } from 'cac-verify';

initAntiCaptcha('INSERT_YOUR_ANTI_CAPTCHA_API_KEY_HERE')

/**
 * search for a company
 */

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

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

// response onError
  {
    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;
  }

Recommend Projects