Download the PHP package asciisd/kyc-shuftipro without Composer
On this page you can find all versions of the php package asciisd/kyc-shuftipro. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download asciisd/kyc-shuftipro
More information about asciisd/kyc-shuftipro
Files in asciisd/kyc-shuftipro
Package kyc-shuftipro
Short Description ShuftiPro driver for KYC (Know Your Customer) verification
License MIT
Informations about the package kyc-shuftipro
Asciisd KYC ShuftiPro Driver
A Laravel package that provides ShuftiPro integration for the Asciisd KYC Core package. Features automatic webhook handling, provider-specific status mapping, and zero-config infrastructure routes.
Package Information
- Package: asciisd/kyc-shuftipro
- Latest Version: v1.0.0
- PHP Requirements: ^8.2
- Laravel Requirements: ^12.0
- License: MIT
✨ Features
- 🚀 Zero-Config Setup: Automatic webhook routes - no manual configuration needed!
- 🎯 Smart Status Mapping: ShuftiPro-specific event mapping to standardized KYC statuses
- 🔄 Complete Integration: Full API integration with ShuftiPro services
- 🛣️ Journey Support: Support for both IDV journeys and direct API verification
- 📁 Document Management: Automatic document download and storage
- 🔒 Secure Webhooks: Signature validation and comprehensive logging
- 🖼️ Image Processing: Support for document images, selfies, and verification videos
- 🔍 Duplicate Detection: Built-in duplicate account detection
- 📊 Comprehensive Logging: Detailed logging for debugging and monitoring
- ⚡ Auto-Infrastructure: Webhook endpoints automatically registered by KYC Core
Installation
Configuration
Publish the configuration file:
Environment Variables
Add these variables to your .env file:
Usage
Basic Verification
Journey-based Verification
🚀 Automatic Webhook Handling
NEW! Webhooks are now handled automatically - no manual route setup required!
Auto-Registered Webhook Routes
The KYC Core package automatically registers these routes:
ShuftiPro Configuration
Simply configure your ShuftiPro webhook URL to:
Benefits
- ✅ Zero Setup - Works immediately after installation
- ✅ Automatic Processing - Webhooks processed with proper status mapping
- ✅ Secure - Built-in signature validation
- ✅ Logged - Comprehensive logging for debugging
- ✅ Consistent - Same behavior across all applications
Manual Webhook Processing (Optional)
If you need custom webhook handling:
Document Management
Configuration
API Configuration
Webhook Configuration
Document Configuration
Supported Features
Document Types
- Identity documents (passport, driver's license, national ID)
- Address verification documents
- Selfie verification
- Video verification
- Verification reports
Verification Methods
- IDV Journey verification
- Direct API verification
- Custom journey configurations
- Country-specific verification rules
Security Features
- Webhook signature validation
- Secure document storage
- Duplicate account detection
- Comprehensive audit logging
Events
The package fires standard KYC events that you can listen to:
Error Handling
The package includes comprehensive error handling:
Testing
🎯 ShuftiPro Status Mapping
The driver automatically maps ShuftiPro events to standardized KYC statuses:
Benefits
- ✅ Automatic Mapping - No manual status handling required
- ✅ Standardized - Consistent status across all KYC providers
- ✅ Provider-Specific - Handles ShuftiPro's unique event names
- ✅ Extensible - Easy to add new event mappings
API Reference
ShuftiProDriver Methods
createVerification(Model $user, KycVerificationRequest $request): KycVerificationResponsecreateSimpleVerification(Model $user, array $options = []): KycVerificationResponseretrieveVerification(string $reference): KycVerificationResponseprocessWebhook(array $payload, array $headers = []): KycVerificationResponsedownloadDocuments(Model $user, string $reference): arrayvalidateWebhookSignature(array $payload, array $headers): bool
Response Data
The package returns comprehensive verification data including:
- Verification status and results
- Extracted document data
- Document image URLs
- Verification video URLs
- Duplicate detection results
- Decline reasons (if applicable)
Contributing
Please see CONTRIBUTING.md for details.
License
The MIT License (MIT). Please see License File for more information.