Skip to main content
Players order documents with a validity period. Expired documents are shown as such.
Restricted documents are shown greyed out with the required job underneath. Add item = 'id_card' to give an inventory item on order (see Compatibility). After ordering, Config.OnDocumentOrdered runs.

Document items

Every document type with an item becomes a real document: a serial number, the holder’s webcam photo, a signature and the fields you list. No extra script is needed.
  • Fields: firstName, lastName, dateOfBirth, sex, height, nationality, ssn, job, jobGrade. The data is saved when the document is issued (like a printed card). Fields the framework doesn’t have are left out.
  • SSN: ESX’s own users.ssn is used; on other frameworks City Hall gives every character a unique SSN (aps_citizens).
  • Using the item shows the document to the holder and everyone within showDistance as an ID-1 card in US driver-license layout (field codes, ghost photo, printed skyline), with a live VALID hologram or EXPIRED / REVOKED stamp. H (flipKey) turns it over to the back side (barcodes, restrictions, issuer) and back; Backspace (hideKey) puts it away early. template = 'badge' uses a dark badge-case layout.
  • /checkdocument lets the listed jobs (job = minimum grade) look up any document.
  • Lost items: My documents → Print copy prints the same document again for reprintPrice. Revoking a document in the Government Portal invalidates every copy.
  • Items: ESX inventory — sql/items_esx.sql. ox_inventory — add server = { export = 'aps_cityhall.useDocument' } and consume = 0 to each document item (see License cards → Items for the format).

vms_documentsv2

  • With system = 'auto' and vms_documentsv2 running (start it before aps_cityhall), the Document Office issues documents through vms_documentsv2 using each type’s vms name, including the license documents (Driving → driving_license, Boat → boat_license, Pilot → flying_license, CCW → weapon_license). Revoking in the Government Portal calls vms’ invalidateDocument.
  • The default item names match vms_documentsv2’s (id_card, driving_license, police_badge, weapons_license), so switching systems doesn’t need new items.
  • Without vms_documentsv2, Config.Compat.vmsDocuments = true answers scripts that call exports['vms_documentsv2']: giveDocument, isAnyDocumentValid, invalidateDocument, getMyDocuments, GenerateSSN.