# cac-verify

> Search and Verify if a company is registered in Nigeria

Latest version **2.1.0** (published 2023-03-30) · ISC license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install cac-verify
pnpm add cac-verify
yarn add cac-verify
bun add cac-verify
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.1.0 |
| Published | 2023-03-30 |
| First published | 2021-01-24 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 17 |
| Author | Ashiru Olawale |
| Maintainers | walebant |
| Keywords | nodejs, typescript, javascript |

## Links

- npm: https://www.npmjs.com/package/cac-verify
- Repository: https://github.com/walebant/cac-verify
- Homepage: https://github.com/walebant/cac-verify#readme
- Issues: https://github.com/walebant/cac-verify/issues
- npm.io page: https://npm.io/package/cac-verify

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 2.1.0 (latest) — 2023-03-30
- 2.0.0 — 2023-03-30
- 1.1.2 — 2021-01-24
- 1.1.1 — 2021-01-24
- 1.1.0 — 2021-01-24
- 1.0.5 — 2021-01-24
- 1.0.4 — 2021-01-24
- 1.0.3 — 2021-01-24
- 1.0.2 — 2021-01-24
- 1.0.1 — 2021-01-24
- 1.0.0 — 2021-01-24

## README

# 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](https://www.cac.gov.ng).

<!-- [START usecases] -->

###### 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.
<!-- [END usecases] -->

<!-- [START getstarted] -->

## Getting Started

### Installation

To use cac-verify in your project, run:

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

### Usage

```js
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;
  }
```

---
_Source: https://npm.io/package/cac-verify · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._