README

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.0.0 or higher
• 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 requirements, so no additional server configuration is needed.

Features

• Secure KYC file uploads (ID, proof of address)
• End-to-end file encryption (OpenSSL)
• Front-office upload & status tracking
• Back-office admin panel: validation, document checking, logs
• Order blocking for sensitive products until KYC is validated
• Easy installation, configuration, and uninstall
• Multi-language ready
• 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

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

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