> ## Documentation Index
> Fetch the complete documentation index at: https://sigma-docs.pastelhq.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting Started

> Set up and run KYC lookups

<Note>
  **API Credentials Required:** Before making any KYC lookup, you must have your API key and secret configured.
  You can retrieve your credentials from the [API & Webhook settings](/account/api-webhook) page.
</Note>

### The KYC Flow

Running a KYC lookup in Sigma is straightforward:

**1. Get Your API Credentials**

Retrieve your `apiKey` and `apiSecret` from **My Account → API & Webhooks** in the Sigma dashboard. These headers are required on every request.

[See how to get your API credentials →](/account/api-webhook)

**2. Choose a Lookup Type**

Sigma KYC supports three lookup types depending on what you need to verify:

| Lookup         | Endpoint               | When to use                                                     |
| -------------- | ---------------------- | --------------------------------------------------------------- |
| **BVN Search** | `POST /api/v1/kyc/bvn` | Verify an individual using their Bank Verification Number       |
| **NIN Search** | `POST /api/v1/kyc/nin` | Verify an individual using their National Identification Number |
| **CAC Search** | `POST /api/v1/kyc/cac` | Verify a business using its CAC registration number             |

**3. Send the Request**

Make a POST request to the appropriate endpoint with the required payload. For BVN and NIN, send the `idNumber` field. For CAC, send the `rcNumber`, `companyName`, and `companyType` fields.

**4. Parse the Response**

The API returns verified data from government databases including personal details, contact information, photos, and (for CAC) affiliated persons such as directors and shareholders.

### Authentication

All KYC requests require two custom headers:

| Header      | Description     |
| ----------- | --------------- |
| `apiKey`    | Your API key    |
| `apiSecret` | Your API secret |

```javascript theme={null}
const headers = {
  apiKey: "your-api-key-here",
  apiSecret: "your-api-secret-here",
};
```

### Environments

KYC is available in both sandbox and production environments. The sandbox returns static responses for testing at no cost. Production performs real lookups and consumes wallet balance.

See the [Environments](/api-reference/environments) page for base URLs.

### Prerequisites

Before making your first KYC lookup, make sure you have:

* An active Sigma account
* API key and secret configured in [API & Webhook settings](/account/api-webhook)
* Wallet balance loaded (for production requests)

<CardGroup cols={3}>
  <Card title="BVN Search" icon="id-card" href="/products/kyc/bvn-search">
    Look up individual identity using a BVN.
  </Card>

  <Card title="NIN Search" icon="address-card" href="/products/kyc/nin-search">
    Look up individual identity using a NIN.
  </Card>

  <Card title="CAC Search" icon="building" href="/products/kyc/cac-search">
    Look up business registration using a CAC number.
  </Card>
</CardGroup>