README

Parse and validate Bangladesh National ID (NID) numbers. Extract NID number, digit type (10-digit old card / 17-digit smart card), date of birth, and name from raw OCR text. Zero dependencies.

composer require jarir-ahmed/bd-nid-parser

Quick Start

use JarirAhmed\BdNid\BdNid;

// Parse full card OCR text
$result = BdNid::parse("Name: MD. JARIR AHMED NID: 4212964672 Date of Birth: 17 May 2000");
// [
//   'number'      => '4212964672',
//   'type'        => '10',
//   'name'        => 'MD. JARIR AHMED',
//   'dateOfBirth' => '2000-05-17',
// ]

// Validate NID number
BdNid::validate('4212964672');            // true
BdNid::validate('12345678901234567');     // true (smart card)
BdNid::validate('12345');                 // false

// Detect card type
BdNid::getDigitType('4212964672');        // '10'
BdNid::getDigitType('12345678901234567'); // '17'

API

parse(string $text): array

Extract NID number, type, name, and DOB from raw OCR text.

Returns:

• number — NID number (digits only), or null
• type — '10' (old card) or '17' (smart card), or null
• name — Person name in uppercase, or null
• dateOfBirth — DOB in YYYY-MM-DD format, or null

validate(string $number): bool

Check if an NID number is valid (10 or 17 digits).

getDigitType(string $number): ?string

Detect card type: '10' or '17', returns null if invalid.

Supported DOB Formats

Supports both English and Bangla (নাম) name extraction.

Optional: NID Verification via nidlive.com

The package includes an optional NidLiveVerifier that integrates with nidlive.com — an identity verification service using image-based face/NID matching. This package uses their API for verification, and we credit them for providing this service.

To use the verifier, sign up at nidlive.com, purchase a subscription, and obtain your Client ID & Secret from the dashboard.

use JarirAhmed\BdNid\Verifiers\NidLiveVerifier;

$verifier = new NidLiveVerifier(
    clientId: 'your-client-id',
    clientSecret: 'your-client-secret'
);

// Submit NID front/back images + selfie for verification
$result = $verifier->submitVerification(
    nidFrontBase64: $frontImageBase64,
    nidBackBase64:  $backImageBase64,
    selfieBase64:   $selfieBase64,
);

// Check verification status
$status = $verifier->checkStatus('VRF-ABC123');

// Test API connectivity (no auth required)
$info = $verifier->testConnection();

nidlive.com Plans

Requires ext-curl and ext-json. See full API docs at nidlive.com/api-docs.

Testing

composer install
composer test

License

MIT

bd-nid-parser