Skip to main content
The LumiID Python SDK wraps the LumiID Identity Verification API so you can verify Nigerian identity records directly from your Python application. Use it to run KYC, business verification, payment validation, and fraud-prevention checks against NIN, BVN, CAC, TIN, and NUBAN records. The SDK exposes a single client.verify() method that covers every supported ID type, raises typed exceptions for every error case, and supports advanced lookups for enriched data where available. Install it with pip install lumiid. Python 3.8 or later is required.

Installation

Install the package from PyPI:
The SDK automatically installs requests >= 2.28.0 as a dependency.

Authentication

Obtain your API key from the LumiID dashboard and pass it when creating the client. The recommended approach is to read it from an environment variable:
Store your API key in an environment variable or secret manager — never hardcode it in source code or commit it to version control.

Quick Start

Verify a NIN in three lines once the client is configured:

Verification Examples

Every ID type uses the same client.verify() method. Pass the id_type, id_number, and optionally advance=True for enriched results where supported.

NIN Verification

Verify an 11-digit National Identification Number (NIN). Pass advance=True to fetch the full NIMC profile.

BVN Verification

Verify an 11-digit Bank Verification Number (BVN). Advanced lookup is available.

CAC Business Verification

Verify a Nigerian Corporate Affairs Commission (CAC) registration number. Use the RC prefix, for example RC1234567. Pass advance=True to retrieve directors and shareholders.

TIN Verification

Verify a Nigerian Tax Identification Number (TIN). TIN supports basic verification only.

NUBAN Account Verification

Verify a 10-digit Nigerian Uniform Bank Account Number (NUBAN). NUBAN supports basic verification only.

Supported ID Types


Error Handling

The SDK raises typed exceptions so you can handle each failure case precisely. Always catch specific exceptions before the base LumiIDError.

Exception Reference


Client Configuration

The LumiID constructor accepts two parameters: Increase timeout if you’re on a slower network or experiencing intermittent timeouts:

Requirements