README.md

Age Verification Plugin for Sylius

A plugin to add age verification to your Sylius store using VerifyID as the age verification provider.

During checkout, if the customer's cart contains products with a minimum age requirement and the shipping address is in an enabled country, the plugin prompts the customer to verify their age via VerifyID before completing the order. Supported minimum age thresholds are 16 and 18.

Prerequisites

You need a VerifyID account. From the VerifyID dashboard, obtain your Plugin Key.

Installation

Step 1: Install the plugin

composer require setono/sylius-age-verification-plugin

Step 2: Register the bundle

Add the plugin to your config/bundles.php file:

return [
    // ...
    Setono\SyliusAgeVerificationPlugin\SetonoSyliusAgeVerificationPlugin::class => ['all' => true],
    // ...
];

Step 3: Configure environment variables

Add the following environment variable to your .env.local:

VERIFYID_PLUGIN_KEY=your-plugin-key

Step 4: Import routes

Create config/routes/setono_sylius_age_verification.yaml:

setono_sylius_age_verification:
    resource: "@SetonoSyliusAgeVerificationPlugin/Resources/config/routes.yaml"

Step 5: Configure the plugin

Create config/packages/setono_sylius_age_verification.yaml:

setono_sylius_age_verification:
    enabled_countries:
        - DK # Add the country codes where age verification should be enforced

Step 6: Extend entities

Extend the Customer entity

<?php

declare(strict_types=1);

namespace App\Entity\Customer;

use Doctrine\ORM\Mapping as ORM;
use Setono\SyliusAgeVerificationPlugin\Model\AgeAwareCustomerInterface;
use Setono\SyliusAgeVerificationPlugin\Model\AgeAwareCustomerTrait;
use Sylius\Component\Core\Model\Customer as BaseCustomer;

#[ORM\Entity]
#[ORM\Table(name: 'sylius_customer')]
class Customer extends BaseCustomer implements AgeAwareCustomerInterface
{
    use AgeAwareCustomerTrait;
}

Register it in your Sylius configuration (e.g. config/packages/_sylius.yaml):

sylius_customer:
    resources:
        customer:
            classes:
                model: App\Entity\Customer\Customer

Extend the Product entity

<?php

declare(strict_types=1);

namespace App\Entity\Product;

use Doctrine\ORM\Mapping as ORM;
use Setono\SyliusAgeVerificationPlugin\Model\AgeAwareProductInterface;
use Setono\SyliusAgeVerificationPlugin\Model\AgeAwareProductTrait;
use Sylius\Component\Core\Model\Product as BaseProduct;

#[ORM\Entity]
#[ORM\Table(name: 'sylius_product')]
class Product extends BaseProduct implements AgeAwareProductInterface
{
    use AgeAwareProductTrait;
}

Register it in your Sylius configuration (e.g. config/packages/_sylius.yaml):

sylius_product:
    resources:
        product:
            classes:
                model: App\Entity\Product\Product

Step 7: Update your database schema

bin/console doctrine:migrations:diff
bin/console doctrine:migrations:migrate

Usage

Once installed, an Age verification tab appears on the product edit page in the Sylius admin. Set a minimum age (16 or 18) for any product that requires age verification.

During checkout, if the order contains age-restricted products and the shipping address is in one of the configured enabled_countries, the customer will be prompted to verify their age via VerifyID before they can complete the order. Once verified, the result is stored on the customer entity and reused for future orders.