esx_license

esx_license keeps track of which licenses each player owns, for example a driving license or a weapon permit. Other resources such as esx_dmvschool, esx_boat, esx_vehicleshop and esx_weaponshop grant and check licenses through it.

OverviewCopy Anchor Link

InstallationCopy Anchor Link

CREATE TABLE `licenses` (
	`type` varchar(60) NOT NULL,
	`label` varchar(60) NOT NULL,
	PRIMARY KEY (`type`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;

CREATE TABLE `user_licenses` (
	`id` int NOT NULL AUTO_INCREMENT,
	`type` varchar(60) NOT NULL,
	`owner` VARCHAR(60) NOT NULL,
	PRIMARY KEY (`id`),
	UNIQUE KEY `uq_user_licenses_owner_type` (`owner`, `type`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;

INSERT INTO `licenses` (`type`, `label`) VALUES ('weapon', 'Weapon License');

ensure esx_license

On start the resource checks user_licenses for duplicate owner + type rows. If it finds any it stops granting licenses and prints Schema migration failed; grants disabled. Remove the duplicates and restart. If the unique key is missing it adds it. The same migration is shipped as sql/security_hardening_2026_10_02.sql in the addons repo; see the addons overview.

ConfigurationCopy Anchor Link

Who may read another player's licensesCopy Anchor Link

A client request for another player passes when one of these is true:

• The caller asks about themselves.
• The caller's group is admin or superadmin.
• The caller's job is in Config.allowedJobs, the job's onDuty is not false, and the target is within Config.LicenseCheckDistance.

Server eventsCopy Anchor Link

Local events for other server scripts. Clients cannot trigger them, except removeLicense.

esx_license:addLicenseCopy Anchor Link

TriggerEvent('esx_license:addLicense', playerId, licenseType, cb)

TriggerEvent('esx_license:addLicense', source, 'weapon', function(result)
    if result then
        TriggerClientEvent('esx:showNotification', source, 'Weapon license issued')
    end
end)

esx_license:checkLicenseCopy Anchor Link

TriggerEvent('esx_license:checkLicense', playerId, licenseType, cb)

cb(hasLicense) receives a boolean. Nothing happens if the player is offline.

TriggerEvent('esx_license:checkLicense', source, 'drive', function(hasLicense)
    if not hasLicense then
        return TriggerClientEvent('esx:showNotification', source, 'You need a driving license')
    end
    -- continue
end)

esx_license:getLicensesCopy Anchor Link

TriggerEvent('esx_license:getLicenses', playerId, cb)

cb(licenses) receives an array of { type, label } for an online player.

esx_license:getLicenseCopy Anchor Link

TriggerEvent('esx_license:getLicense', licenseType, cb)

cb({ type = licenseType, label = label }). label is nil when the type does not exist. This reads the catalog; it does not check a player.

esx_license:getLicensesListCopy Anchor Link

TriggerEvent('esx_license:getLicensesList', function(list)
    for _, license in ipairs(list) do
        print(license.type, license.label)
    end
end)

Returns the cached catalog, loaded on start and refreshed on esx:sqlCatalogReady.

esx_license:removeLicense (net event)Copy Anchor Link

TriggerServerEvent('esx_license:removeLicense', targetId, licenseType)

To remove a license from server code, delete the row yourself:

local xTarget = ESX.Player(targetId)

MySQL.update('DELETE FROM user_licenses WHERE type = ? AND owner = ?', {
    'weapon', xTarget.getIdentifier(),
})

Client callbacksCopy Anchor Link

Call with ESX.TriggerServerCallback, ESX.AwaitServerCallback or xLib.callback.

targetId defaults to the caller when omitted. Reading someone else uses the permission rules above.

ESX.TriggerServerCallback('esx_license:checkLicense', function(hasLicense)
    if hasLicense then
        OpenGunShop()
    else
        ESX.ShowNotification('You need a weapon license')
    end
end, GetPlayerServerId(PlayerId()), 'weapon')

Common issuesCopy Anchor Link

• addLicense does nothing: the type is missing in licenses, or the player is offline. Check the server console for Missing license type in db.
• Grants disabled after update: duplicate rows in user_licenses. Remove them and restart.
• Police cannot see licenses: the officer is too far away (5 m), off duty, or the job is not in Config.allowedJobs.

RelatedCopy Anchor Link

• esx_dmvschool
• esx_weaponshop
• esx_policejob
• Database schema

Frequently asked questions