> For the complete documentation index, see [llms.txt](https://docs.lumiid.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.lumiid.com/welcome-to-lumiid.md).

# Welcome to LumiID

Whether you're building a fintech app, lending platform, HR system, marketplace, healthcare platform, or enterprise workflow, LumiID enables you to verify identities in seconds while reducing fraud and meeting compliance requirements.

## What you can Build

With LumiID APIs you can:

* Verify Nigerian NIN records
* Verify BVNs
* Verify CAC business registrations
* Verify TINs
* Verify bank accounts
* Validate NUBAN account details
* Perform business verification
* Build secure customer onboarding
* Detect fraudulent identities
* Monitor identity risk over time

### Why LumiID?

#### Fast Integration

REST APIs with JSON responses that can be integrated in minutes.

#### Enterprise Security

Encrypted communication, secure authentication, and NDPR-aligned data handling.

#### Built for Africa

Purpose-built infrastructure designed for African identity systems rather than adapted from global solutions.

#### Reliable

High availability infrastructure designed for production workloads.

#### Developer Friendly

Clear documentation, predictable APIs, sandbox environment, and consistent error handling.

### Who uses LumiID?

LumiID powers identity verification for:

* Fintechs
* Digital Banks
* Lending Platforms
* Payment Providers
* HR Platforms
* Payroll Systems
* Insurance Companies
* Telecommunications
* Government Services
* Healthcare Providers
* E-commerce Platforms

***

### Available APIs

| API                   | Description                            |
| --------------------- | -------------------------------------- |
| NIN Verification      | Verify National Identification Numbers |
| BVN Verification      | Verify Bank Verification Numbers       |
| CAC Verification      | Validate registered businesses         |
| TIN Verification      | Verify taxpayer records                |
| Account Verification  | Validate bank account ownership        |
| Phone Verification    | Verify phone numbers                   |
| Business Verification | Verify company identity                |
| Fraud Intelligence    | Assess identity risk                   |

***

### API Base URL

Production

```
https://api.lumiid.com/v1/
```

Sandbox

```
https://api.lumiid.com/v1/
```

***

### Response Format

All responses are returned as JSON.

Successful response

```json
{    
    "success": true,    
    "message": "Verification completed",    
    "data": {}
}
```

Failed response

{% code overflow="wrap" %}

```json
{    
    "success": false,    
    "message": "Invalid NIN",    
    "error": {        
    "code": "INVALID_NIN"    
    }
}
```

{% endcode %}

***

### Next Steps

If you're integrating LumiID for the first time:

1. Create a LumiID account
2. Generate your API keys
3. Make your first API request
4. Go live

Continue to the:

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th><select></select></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h4><i class="fa-rocket-launch" style="color:$primary;">:rocket-launch:</i></h4></td><td><h4>Getting started</h4></td><td>Integrate LumiID in less than five minutes.</td><td></td><td><a href="/pages/PbYb0GukRhiS4qCHdRal">/pages/PbYb0GukRhiS4qCHdRal</a></td></tr><tr><td><h4><i class="fa-book" style="color:$primary;">:book:</i></h4></td><td><h4>Core concepts</h4></td><td>Understand workspaces, projects, and how permissions work.</td><td></td><td><a href="/pages/EFXeLTHVDQLFgK0Iy51O">/pages/EFXeLTHVDQLFgK0Iy51O</a></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.lumiid.com/welcome-to-lumiid.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
