Download the PHP package asciisd/kyc-core without Composer
On this page you can find all versions of the php package asciisd/kyc-core. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download asciisd/kyc-core
More information about asciisd/kyc-core
Files in asciisd/kyc-core
Package kyc-core
Short Description Core KYC (Know Your Customer) functionality for Laravel applications with enhanced webhook data merging
License MIT
Informations about the package kyc-core
Asciisd KYC Core
A comprehensive Laravel package for KYC (Know Your Customer) verification management. This package provides a clean, extensible architecture for integrating multiple KYC providers with automatic infrastructure routes and provider-agnostic status mapping.
✨ Key Features
- 🚀 Zero-Config Infrastructure: Webhook routes automatically registered - no setup required!
- 🔄 Provider-Agnostic Architecture: Seamlessly switch between KYC providers (ShuftiPro, Jumio, Onfido, etc.)
- 🎯 Driver-Based Status Mapping: Each provider handles its own event-to-status mapping
- 📡 Auto-Registered Routes: Infrastructure routes work out-of-the-box
- 🎪 Event-Driven: Comprehensive event system for verification lifecycle
- 📊 Smart Status Management: Intelligent status tracking and transitions
- 📁 Document Management: Built-in document storage and retrieval
- 🔒 Secure Webhooks: Signature validation and comprehensive logging
- ✅ Built-in Validation: Request validation and user eligibility checks
- 🔍 Comprehensive Logging: Detailed logging for debugging and monitoring
- 🔗 Morphable Models: Works with any Eloquent model using morphable relationships
Installation
Configuration
Publish the configuration file:
Publish the migrations:
Run the migrations:
🚀 Automatic Infrastructure Routes
NEW! The package now automatically registers infrastructure routes - no manual setup required!
Auto-Registered Routes
When you install the package, these routes are automatically available:
Benefits
- ✅ Zero Configuration - Works immediately after installation
- ✅ Consistent Behavior - Same webhook handling across all applications
- ✅ Provider Agnostic - Works with any KYC driver
- ✅ Automatic Updates - Bug fixes and improvements benefit all apps
- ✅ Simplified Integration - Focus on business logic, not infrastructure
Health Check
Monitor your KYC system health:
🚀 Quick Start
Minimal Setup (3 Steps!)
-
Install the package
-
Publish and run migrations
- Add trait to your User model
That's it! 🎉 Infrastructure routes are automatically registered. Just configure your KYC provider credentials and start verifying users.
Usage
Basic Usage
Model Integration
Add the trait to your User model:
Now you can use KYC methods on your user:
Events
The package fires several events you can listen to:
Status Management
The package includes a comprehensive status enum:
🏗️ Advanced Driver Architecture
The package uses a sophisticated driver-based architecture with provider-specific status mapping:
🎯 Provider-Specific Status Mapping
Each driver handles its own event-to-status mapping, making the system truly provider-agnostic:
Benefits
- ✅ Provider Independence - Each provider handles its own event mapping
- ✅ Easy Migration - Switch providers without changing application logic
- ✅ Extensible - Add new providers by implementing the interface
- ✅ Consistent - Standardized KYC status across all providers
Configuration
The package configuration allows you to:
- Set default driver
- Configure multiple drivers
- Set verification settings
- Define supported/restricted countries
- Configure document storage
Testing
Contributing
Please see CONTRIBUTING.md for details.
License
The MIT License (MIT). Please see License File for more information.
All versions of kyc-core with dependencies
laravel/framework Version ^12.0|^13.0
intervention/validation Version ^4.0