Download the PHP package vachmara/pskyc without Composer
On this page you can find all versions of the php package vachmara/pskyc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download vachmara/pskyc
More information about vachmara/pskyc
Files in vachmara/pskyc
Package pskyc
Short Description Open source, GDPR-compliant KYC document verification for PrestaShop 8 and 9.
License MIT
Homepage https://github.com/vachmara/pskyc
Informations about the package pskyc
KYC Secure Upload (PrestaShop Module)
Open source, GDPR-compliant KYC document verification for PrestaShop.
- Proof of identity (ID)
- Proof of address (utility bill, bank statement, etc.)
- Secure file storage with encryption
- Product order blocking until KYC is validated
Requirements
PrestaShop Compatibility
- PrestaShop: 8.x – 9.x
Tested PrestaShop releases
Official continuous integration covers PrestaShop 8.0, 8.1, 8.2 and 9.0 Docker images to ensure ongoing compatibility across both major branches.
- PHP: 8.1 or higher
PHP Extensions
This module uses standard PrestaShop-required PHP extensions:
- fileinfo - For MIME type detection of uploaded documents
- openssl - For AES-256-CBC document encryption
- curl - For HTTP requests (standard PrestaShop requirement)
- gd - For image processing (standard PrestaShop requirement)
- json - For configuration data (standard PrestaShop requirement)
- mbstring - For string handling (standard PrestaShop requirement)
All listed extensions are standard PrestaShop 8/9 requirements, so no additional server configuration is needed.
Features
- [x] Secure KYC file uploads (ID, proof of address)
- [x] End-to-end file encryption (OpenSSL)
- [x] Front-office upload & status tracking
- [x] Back-office admin panel: validation, document checking, logs
- [x] Order blocking for sensitive products until KYC is validated
- [x] Easy installation, configuration, and uninstall
- [x] Multi-language ready
- [x] Automated email notifications (status updates, document confirmations, admin alerts)
Installation
- Download the latest release ZIP
- Upload to your PrestaShop back office (Modules > Module Manager > Upload)
- Configure in the modules section
Quick Start
Get up and running in minutes with automatic integration.
Basic Setup
- Install the module via PrestaShop back office
- Configure KYC categories:
- Go to Modules → KYC Secure Upload → Configure
- Select product categories that require KYC verification
- That's it! The module works automatically with any checkout
How It Works
- Automatic blocking: Orders for KYC-required products are blocked until verification is approved
- Server-side security: Cannot be bypassed via frontend modifications
- Clear messaging: Customers see helpful error messages and redirects
Testing Checklist
- Configure categories requiring KYC in module settings
- Test as unverified customer:
- Add KYC-required product to cart
- Complete checkout process
- ✅ Should see error and redirect to KYC verification
- Test as verified customer:
- Complete KYC verification (get admin approval)
- Add same product and checkout
- ✅ Order should process normally
- Test non-KYC products:
- Add regular product to cart
- ✅ No KYC check, order processes normally
Common Issues
- Orders going through without KYC: Reinstall module to ensure hooks are registered
- No error messages: Check PrestaShop logs at
var/logs/ - Warnings not appearing: Clear cache in Advanced Parameters → Performance
Third-Party Checkout Integration
This module works seamlessly with PrestaShop's standard checkout and is compatible with third-party checkout modules like Prestahero One Page Checkout.
📖 Complete Integration Guide - Comprehensive documentation for integrating with third-party checkout modules including:
- Prestahero One Page Checkout
- Custom checkout modules
- Override examples and best practices
- Troubleshooting and extension points
Security
- Files are stored encrypted with OpenSSL (
AES-256-CBC) - Keys and IV managed securely
- .htaccess restricts direct access
- GDPR retention and deletion supported
Flow Diagram
Email Types Summary
| Email Type | Trigger | Recipient | Template | Purpose |
|---|---|---|---|---|
| Upload Confirmation | Document upload success | Customer | document_upload_confirmation |
Confirm receipt |
| Admin Notification | Document upload success | Admins | admin_new_verification |
Alert for review |
| Status Change | Admin updates status | Customer | verification_status |
Notify of decision |
| Expiry Warning | 30 days before expiry | Customer | verification_expiry_warning |
Renewal reminder |
Email Templates
Email templates are located in:
- Text versions:
mails/{lang}/ - HTML versions:
mails/layouts/
Available languages: en, fr
⚠️ Known Issue: Email Template Generation
There is a known bug in PrestaShop 8.1.2 preventing email template generation for custom modules through the admin interface. Email sending functionality works normally.
Details: PrestaShop Issue #35214
Contribution
PRs welcome! See CONTRIBUTING.md for guidelines.
License
MIT License. See LICENSE.md for details.