esx_identity

esx_identity is the ESX Legacy resource that asks a new player for their character's first name, last name, date of birth, sex and height, validates the input on the server and stores it in the users table. Use it on every ESX server; both the single-character flow and esx_multicharacter depend on it.

OverviewCopy Anchor Link

InstallationCopy Anchor Link

Run the bundled SQL once if your users table does not have the identity columns yet (the official txAdmin recipe already includes them):

ALTER TABLE `users`
	ADD COLUMN `firstname` VARCHAR(16) NULL DEFAULT NULL,
	ADD COLUMN `lastname` VARCHAR(16) NULL DEFAULT NULL,
	ADD COLUMN `dateofbirth` VARCHAR(10) NULL DEFAULT NULL,
	ADD COLUMN `sex` VARCHAR(1) NULL DEFAULT NULL,
	ADD COLUMN `height` INT NULL DEFAULT NULL;

Then ensure it after es_extended and esx_lib:

ensure esx_lib
ensure es_extended
ensure esx_identity

How it worksCopy Anchor Link

ConfigurationCopy Anchor Link

All keys live in config.lua.

Validation rulesCopy Anchor Link

The server never trusts the NUI. A registration is rejected with an error notification when:

A player that is already registered cannot register again (already_registered).

Reading identity dataCopy Anchor Link

After loading, the identity is stored on the xPlayer and replicated to the player's state bag.

local xPlayer = ESX.GetPlayerFromId(source)
if not xPlayer then return end

local fullName  = xPlayer.getName()            -- "John Doe"
local firstName = xPlayer.get('firstName')
local lastName  = xPlayer.get('lastName')
local dob       = xPlayer.get('dateofbirth')   -- "24/12/1995"
local sex       = xPlayer.get('sex')           -- "m" or "f"
local height    = xPlayer.get('height')        -- 180

-- also available to any resource via state bags
local state = Player(source).state
print(state.firstName, state.lastName)

EventsCopy Anchor Link

esx_identity:completedRegistrationCopy Anchor Link

Server event fired by esx_identity when a player finishes the form in multicharacter mode only. esx_multicharacter listens to it to create the new character. In single-character mode the identity is saved directly and this event is not fired.

AddEventHandler('esx_identity:completedRegistration', function(source, data) end)

AddEventHandler('esx_identity:completedRegistration', function(source, data)
    print(('Player %s registered as %s %s'):format(source, data.firstname, data.lastname))
end)

esx_identity:showRegisterIdentityCopy Anchor Link

Client event that opens the registration form. It waits for the NUI and the loading screen, then opens the form unless the player is dead. It also triggers esx_skin:resetFirstSpawn. It is registered as a net event, so the server can send it:

TriggerClientEvent('esx_identity:showRegisterIdentity', playerId)

Internal eventsCopy Anchor Link

CommandsCopy Anchor Link

Common issuesCopy Anchor Link

• Registration always fails with "Invalid Format (DOB)". The form sends the date in Config.DateFormat, but the server validator only parses DD/MM/YYYY. With YYYY/MM/DD every submission fails, and with MM/DD/YYYY dates with a day above 12 fail. Keep the default format.
• Long names get cut or the query errors. MaxNameLength is 20, but the SQL columns are VARCHAR(16). Either lower Config.MaxNameLength to 17 or widen the columns.
• Form never opens. The client waits for both the NUI ready message and esx:loadingScreenOff. A custom loading screen that never shuts down blocks the form. Check the F8 console for "Waiting for esx_identity NUI..".
• "identifier-missing" on connect. The player has no license identifier (for example sv_lan). Fix the identifier setup in es_extended.
• Height notification says inches. The English debug string reads "Inches", but the value is stored in centimeters.

RelatedCopy Anchor Link

• esx_multicharacter
• esx_skin
• xPlayer functions
• Player data
• Database schema

Frequently asked questions