KYC Secure Upload

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

1. Download the latest release ZIP 2. Upload to your PrestaShop back office (Modules > Module Manager > Upload) 3. Configure in the modules section

Quick Start

Get up and running in minutes with automatic integration.

Basic Setup

1. Install the module via PrestaShop back office 2. Configure KYC categories:

• Go to Modules → KYC Secure Upload → Configure
• Select product categories that require KYC verification

3. 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

1. Configure categories requiring KYC in module settings 2. Test as unverified customer:

• Add KYC-required product to cart
• Complete checkout process
• ✅ Should see error and redirect to KYC verification

3. Test as verified customer:

• Complete KYC verification (get admin approval)
• Add same product and checkout
• ✅ Order should process normally

4. 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 <code>var/logs/</code>
• 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 (<code>AES-256-CBC</code>)
• Keys and IV managed securely
• .htaccess restricts direct access
• GDPR retention and deletion supported

Flow Diagram

flowchart TD

A[Customer Uploads Documents] --> B[Create Verification Record] B --> C[Upload Documents to Encrypted Storage] C --> D{All Documents Uploaded Successfully?}

D -->|Yes| E[Send Upload Confirmation to Customer] D -->|No| F[Show Upload Errors]

E --> G[Send Admin Notification] G --> H[Admin Reviews Documents]

H --> I{Admin Decision} I -->|Approve| J[Update Status to 'approved'] I -->|Reject| K[Update Status to 'rejected'] I -->|Request More Info| L[Update Status to 'requested_more_info'] I -->|Under Review| M[Update Status to 'under_review']

J --> N[Send Approval Email to Customer] K --> O[Send Rejection Email to Customer] L --> P[Send Request More Info Email to Customer] M --> Q[Send Under Review Email to Customer]

J --> R[Set Expiry Date] R --> S[Schedule Expiry Warning Check]

S --> T{30 Days Before Expiry?} T -->|Yes| U[Send Expiry Warning to Customer] T -->|No| V[Continue Monitoring]

U --> W{Documents Expired?} W -->|Yes| X[Auto-Update Status to 'expired'] W -->|No| V

X --> Y[Send Expiry Notification to Customer]

%% Simplified semantic color scheme (4 colors) style A fill:#1976D2,stroke:#0D47A1,stroke-width:2px,color:#ffffff style E fill:#388E3C,stroke:#1B5E20,stroke-width:2px,color:#ffffff style F fill:#D32F2F,stroke:#B71C1C,stroke-width:2px,color:#ffffff style G fill:#F57C00,stroke:#E65100,stroke-width:2px,color:#ffffff style N fill:#388E3C,stroke:#1B5E20,stroke-width:2px,color:#ffffff style O fill:#D32F2F,stroke:#B71C1C,stroke-width:2px,color:#ffffff style P fill:#F57C00,stroke:#E65100,stroke-width:2px,color:#ffffff style Q fill:#1976D2,stroke:#0D47A1,stroke-width:2px,color:#ffffff style U fill:#F57C00,stroke:#E65100,stroke-width:2px,color:#ffffff style Y fill:#D32F2F,stroke:#B71C1C,stroke-width:2px,color:#ffffff style X fill:#D32F2F,stroke:#B71C1C,stroke-width:2px,color:#ffffff

Email Types Summary

| Email Type | Trigger | Recipient | Template | Purpose | |------------|---------|-----------|----------|---------| | Upload Confirmation | Document upload success | Customer | <code>document_upload_confirmation</code> | Confirm receipt | | Admin Notification | Document upload success | Admins | <code>admin_new_verification</code> | Alert for review | | Status Change | Admin updates status | Customer | <code>verification_status</code> | Notify of decision | | Expiry Warning | 30 days before expiry | Customer | <code>verification_expiry_warning</code> | Renewal reminder |

Email Templates

Email templates are located in:

• Text versions: <code>mails/{lang}/</code>
• HTML versions: <code>mails/layouts/</code>

Available languages: <code>en</code>, <code>fr</code>

⚠️ 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.