Download the PHP package bvn-verification/bvn-verification-php without Composer
On this page you can find all versions of the php package bvn-verification/bvn-verification-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download bvn-verification/bvn-verification-php
More information about bvn-verification/bvn-verification-php
Files in bvn-verification/bvn-verification-php
Package bvn-verification-php
Short Description A PHP package for Nigerian BVN verification through NIBSS NPS - Perfect for Laravel, Symfony, and any PHP project
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package bvn-verification-php
BVN Verification PHP - User Documentation
A professional PHP package for Nigerian Bank Verification Number (BVN) verification through NIBSS NPS API. Perfect for Laravel, Symfony, and any PHP project requiring secure identity verification.
🚀 Quick Start
Installation
Basic Usage
📦 Installation
For Laravel Projects
-
Install the package:
-
Publish configuration (optional):
- Configure environment variables in
.env:
For Standalone PHP Projects
⚙️ Configuration
Laravel Configuration
After installation, add to your .env file:
Manual Configuration
🎯 Usage Examples
Laravel Usage
Using Facade:
Using Dependency Injection:
Standalone PHP Usage
Basic Verification:
Batch Processing:
🔧 API Reference
Core Methods
verify(string $bvn, string $customerName): VerificationResponse
Verifies a BVN against the provided name.
verifyWithDetails(string $bvn, string $customerName): VerificationResponse
Alias of verify() - provides the same functionality.
Response Object
The VerificationResponse object contains:
isMatch(): bool- Whether BVN and name matchgetVerifiedName(): ?string- Registered name from BVN recordsstatus: string- Verification status ('completed', 'failed')message: ?string- Additional information or error message
Utility Methods
getBVNRecords(): array (Mock mode only)
Returns all available BVN records from mock data.
supportsBVNRecords(): bool
Checks if BVN records are available (only in JSON mock mode).
setMode(string $mode): void
Switch between operation modes.
setSandboxMode(bool $enabled): void
Toggle sandbox mode.
🎪 Mock Data
Using Built-in Mock Data
The package includes sample BVN data for testing:
Custom Mock Data
Create your own JSON file:
🔐 Production Setup
1. Get NIBSS Credentials
Apply for NIBSS NPS API access at NIBSS Plc.
2. Configure for Production
Laravel (.env):
Standalone PHP:
3. Error Handling in Production
🚨 Error Handling
Common Scenarios
Invalid BVN Format:
API Connection Issues:
Best Practices
🧪 Testing
Laravel Tests
Standalone PHP Tests
📋 Common Use Cases
E-commerce Registration
Loan Application
🔗 Support
- Documentation: GitHub Repository
- Issues: GitHub Issues
- Email: [email protected]
📄 License
This package is open-source software licensed under the MIT license.
Ready to verify identities securely? 🚀
Get started today and integrate BVN verification into your PHP applications in minutes!
