Variable Name	Variable Type	Value length	Variable usage/description	Variable Name	Required by TIXnGO API? (Mandatory fields)	Set in SecuTix (Injection Batch or comfort variable)?	SecuTix Mapped Comfort Variable Code	Overwritable by SecuTix's Ticket Template Editor?	Can be overwritten via new injection? (Event Data)
tickets	list		The list of Tickets to be injected. every ticket can hold the entire set of parameters displayed in 2.	tickets	Source https://developer.tixngo.io/api.html#api-Default-organizerTicketsPost Required: event,purchaseDetails,security,spectatorDetails,ticketId	Set systematically by Injection Batch	n/a	no
activationParameters	object		The parameters defining the access control method and details. An activated ticket display its barcode; before activation the barcode is encrypted.	activationParameters	Required	yes	n/a	yes
activationParameters.groupId	string	50 char	The activation group to which the ticket belongs to. Tickets sharing the same activation id will have the same activation method & decryption code.	activationParameters.groupId		no	TIXRGrp	yes
activationParameters.method	string	"online"/"offline"	The method using to activate the ticket. online : when activationTime is reached (backend clock), the backend activates the tickets and sends push notifications to trigger a GET /spectator/tickets on the app. offline: the mobile application activates the tickets when time is reaches (mobile clock). Online requires the user to be online, Offline does not. More on Ticket activation: 5-Understanding TIXnGO Activation flow	activationParameters.method	Required	Set systematically by Injection Batch	n/a	yes
activationParameters.time	string	Date follows RFC 3339 standard	If online is chosen, define the time at which the tickets are activated (decrypted).	activationParameters.time		Comfort Variable	TIXAct	yes
activationParameters.instanceId	string	128 char	If offline is chosen, define the bluetooth instance id that the mobile app should listen to to get the decryption key.	activationParameters.instanceId		no	n/a	yes
image	string	256 char	The uri to the image that will be displayed to the user with its ticket. It must have a width:length ratio of X:Y (to be defined). (displayed on the "Ticket" view).	image		Comfort Variable	TIXImg	yes
event	object		The Event the Ticket gives access to.	event	Required: address,id,name,startTime	yes	n/a	no
event.id	string	256 char	ID representing the event (unique).	event.id	Required	Set systematically by Injection Batch	n/a	no
event.address	object		The Event's Address	event.address	Required: city,countryCode,site,zip	Set systematically by Injection Batch	n/a	no	YES
event.address.site	string	200 char	Name of the site the Event will take place.	event.address.site	Required	Set systematically by Injection Batch	n/a	yes	YES
event.address.line1	string	200 char	Address line 1	event.address.line1		Set systematically by Injection Batch	n/a	yes	YES
event.address.line2	string	200 char	Address line 2	event.address.line2		Set systematically by Injection Batch	n/a	yes	YES
event.address.line3	string	200 char	Address line 3	event.address.line3		Set systematically by Injection Batch	n/a	yes	YES
event.address.city	string	200 char	City where the event takes place	event.address.city	Required	Set systematically by Injection Batch	n/a	yes	YES
event.address.countryCode	string	200 char	Country code for the Address	event.address.countryCode	Required	Set systematically by Injection Batch	n/a	yes	YES
event.address.region	string	200 char	Region where the Event takes place	event.address.region		Set systematically by Injection Batch	n/a	yes	YES
event.address.zip	string	50 char	Zip code where the Event takes place	event.address.zip	Required	Set systematically by Injection Batch	n/a	yes	YES
event.address.longitude	double	double	Longitude where the Event takes place	event.address.longitude		Set systematically by Injection Batch	n/a	-yes	YES
event.address.latitude	double	double	Latitude where the Event takes place	event.address.latitude		Set systematically by Injection Batch	n/a	yes	YES
event.name	string	128 char	Name of the Event	event.name	Required	Set systematically by Injection Batch	n/a	yes
event.name2	string	128 char	Second name of the Event (optional)	event.name2		no	n/a	yes
event.website	string	128 char	Website URL of the Event.	event.website		Comfort Variable	TIXUrl	yes
event.startTime	string	Date follows RFC 3339 standard	Time at which the event starts. Used for app logic such as reminders etc... Date Format: 2022-12-12T16:11:00Z	event.startTime	Required	Comfort Variable	TIXStart	no
event.expirationDate	string	Date follows RFC 3339 standard	Time at which the event expire. Expired event cannot be used anymore.	event.expirationDate		no	n/a	no
event.bluetoothPreparationRibbonDisplayTime	string	Date follows RFC 3339 standard	Time at which a ribbon displays on the mobile app to notify spectator turn on Bluetooth on the phone	event.bluetoothPreparationRibbonDisplayTime
event.bluetoothPreparationRibbonEndTime	string	Date follows RFC 3339 standard	Time at which a ribbon disappear on the mobile app	event.bluetoothPreparationRibbonEndTime
event.metadata	list	list of key-value metadata	Specific "key-value" fields provided to Organizer for special information about the event. For now we handle the reserved keys below. You can override all those keys if you put them (same name, case sensitive) in the ticket details hidden section of the ticket. Reserved Keys : BARCODE_SIZE: value = Size of the barcode display on the Ticket (16 < x < 32) [mm] BARCODE_POSITION: value = Position of the barcode on the Ticket (LEFT, CENTER, RIGHT) RESALE_TICKETSHOP_URL: value = URL of ticket shop that use to resale a ticket (must include http or https) CANCEL_RESALE_TICKETSHOP_URL: value = URL of ticket shop that use to cancel a ticket (must include http or https) EXCHANGE_TICKETSHOP_URL: value = URL of ticket shop that use to exchange a ticket (must include http or https) prohibited_items_image: value = URL of the prohibited items image prohibited_items_link: value = URL of the prohibited items link sponsorImage: value = URL of the sponsors image sponsorLink: value = URL of the sponsors link seat_map_image: value = URL of the seat map image seat_map_link: value = URL of the seat map link enable_covid_check: value = Enable or Disable COVID check functionality for given event EVENT_NUMBER: value = number of the event	event.metadata	Required (if used): key,value	no	n/a	no (note that to overwrite those meta data at the ticket level, please use the hidden object with the same key value pair)
event.group	object		Group the Event belongs to. In TIXnGO multiple events can be grouped together (ex: The same competition could have multiple events).	event.group		no	n/a	no
event.group.id	string	256 char	Id of the Group. Every Event with this Group ID will be part of that Group.	event.group.id		no	n/a	no
event.group.name	string	128 char	Name of the Group.	event.group.name		no	n/a	no
event.group.image	string	256 char	The Image of the Group (displayed on the "My Events" view).	event.group.image		no	n/a	no
proofOfIdentity	object		The informations needed to verify the authenticity of the organizer identity.	proofOfIdentity	Required (if used): publicKey,signedMessage	Set systematically by Injection Batch	n/a	yes
proofOfIdentity.publicKey	string	256 char	The webRootUrl of the organizer. A request on _tixngo.publicKey should give us the organizer public key used to verify the signature.	proofOfIdentity.publicKey	Required	Set systematically by Injection Batch	n/a	yes
proofOfIdentity.signedMessage	string	256 char	Signature of the message (which is a concatenation of different fields. it is available in the documentation).	proofOfIdentity.signedMessage	Required	Set systematically by Injection Batch	n/a	yes
purchaseDetails	object		The information related to the initial purchase of the ticket.	purchaseDetails	Required: date,price,priceCategory,taxationNumber	Set systematically by Injection Batch	n/a	yes
purchaseDetails.price	double	double	The Ticket's price.	purchaseDetails.price	Required	Set systematically by Injection Batch	n/a	yes
purchaseDetails.currency	string	20 char	The currency used in the transaction using ISO-4217 standard (example: CHF, VND, USD).	purchaseDetails.currency		Set systematically by Injection Batch	n/a	yes
purchaseDetails.date	string	Date follows RFC 3339 standard	The date at which the Ticket was initially bought.	purchaseDetails.date	Required	Set systematically by Injection Batch	n/a	no
purchaseDetails.priceCategory	string	512 char	Examples of price category are adult, child, student, senior, VIP, etc.	purchaseDetails.priceCategory	Required	Set systematically by Injection Batch	n/a	yes
purchaseDetails.taxationNumber	string	512 char	(UUID) taxation number of the Ticket.	purchaseDetails.taxationNumber	Required	Set systematically by Injection Batch	n/a	no
contingent	string	256 char	Contingent of a ticket, examples: General Public, host cities, PNA, season tickets, etc. It is used in Admin Tool to search for tickets belonging to this contingent OR filtering tickets while generating reports	contingent		no	n/a	yes
ticketDetails	object		Some supplementary details about the Ticket.	ticketDetails		Set by Injection Batch Configuration	n/a	yes
ticketDetails.main	list	list of key-value metadata	Free "key-value" fields usually used to define spectator seating information such as: gate:A, row:2, seat:7 (Displayed on the "front" of the Ticket).	ticketDetails.main	Required (if used): key,value	Set by Injection Batch Configuration	n/a	yes
ticketDetails.extra	list	list of key-value metadata	Free "key-value" fields usually used to define extra information (Displayed on the "back" of the Ticket). Reserved Keys : file_id : optional field set by the Organizer at injection.	ticketDetails.extra	Required (if used): key,value	Set by Injection Batch Configuration	n/a	yes
ticketDetails.hidden	list	list of key-value metadata	Free "key-value" fields usually used to add hidden information, ex: used between Organizer and TIXnGO (Not displayed on the Ticket). Reserved Keys : transfer_extra : optional field set by the sender during a ticket transfer in transferOrder.extra background_color : optional field set by the Organizer at injection. Define the background color of the ticket. hosp_room: optional field set by the Organizer at injection. Define the hospitality room of the ticket. show_price: optional field set by the Organizer at injection. Define to show or not show the price on ticket extra at_icon: optional field set by the Organizer at injection. Define to show extra icon on the top-left of ticket layout ticketDetailMainNotInBoxes: optional field set by the Organizer at injection. Define how many fields (of ticketDetails.main) that will not stay in boxes (count from the last one) specialColor: optional field set by the Organizer at injection. Define the horizontal stripe color on QRcode part ticket layout Furthermore, you can override the all the event.metadata keys on a per ticket level.	ticketDetails.hidden	Required (if used): key,value	Set by Injection Batch Configuration	n/a	yes
security	object		The Ticket's security information, used by the access control and to enter the event.	security	Required: barcode	Set systematically by Injection Batch	n/a	no
security.barcode	string	512 char	Barcode of the Ticket.	security.barcode	Required	Set systematically by Injection Batch	n/a	no
security.clearanceLevel	integer	integer	Clearance level of the ticket. If 1 is chosen: the organizer require the spectator to provide its name,surname,gender. If 2 is chosen, then all field of SpectatorIdentity are required except for the passport and idcard number, only one of them is required.	security.clearanceLevel		Set systematically by Injection Batch	n/a	no
spectatorDetails	object		The information that will be used to link the ticket to a spectator (the ticket's buyer) in our system. We call this spectator the Initial spectator.	spectatorDetails	Required: email,firstName,lastName	Set systematically by Injection Batch	n/a	yes
spectatorDetails.residenceCountry	string	ISO Alpha-2 format	Initial spectator's residence country.	spectatorDetails.residenceCountry
spectatorDetails.phoneNumber	string	50 char	Initial spectator's phone number.	spectatorDetails.phoneNumber		Set systematically by Injection Batch	n/a	yes
spectatorDetails.email	string	256 char	Initial spectator's email.	spectatorDetails.email	Required	Set systematically by Injection Batch	n/a	yes
spectatorDetails.firstName	string	50 char	Initial spectator's first name.	spectatorDetails.firstName	Required	Set systematically by Injection Batch	n/a	yes
spectatorDetails.lastName	string	100 char	Initial spectator's last name.	spectatorDetails.lastName	Required	Set systematically by Injection Batch	n/a	yes
spectatorDetails.gender	string	1 char (m/f/u/x)	Initial spectator's gender. m, f, u or x (For Male, Female, Other, Unknown)	spectatorDetails.gender		Set systematically by Injection Batch	n/a	yes
spectatorDetails.dateOfBirth	string	Date follows RFC 3339 standard	Initial spectator's birth date.	spectatorDetails.dateOfBirth		Set systematically by Injection Batch	n/a	yes
spectatorDetails.nationality	string	ISO Alpha-2 format	Initial spectator's nationality.	spectatorDetails.nationality		Set systematically by Injection Batch	n/a	yes
spectatorDetails.passportNumber	string	200 char	Initial spectator's passport number.	spectatorDetails.passportNumber		Set systematically by Injection Batch	n/a	yes
spectatorDetails.idCardNumber	string	200 char	Initial spectator's ID card number.	spectatorDetails.idCardNumber		Set systematically by Injection Batch	n/a	yes
spectatorDetails.spectatorStatus	string	"Activated" / "Not activatied"	If the initial spectator is registered in the TIXnGO system.	spectatorDetails.spectatorStatus		no	n/a	yes
spectatorDetails.ticketHolder	object		Used to show that this Ticket is held for someone else on the Initial spectator's phone.	spectatorDetails.ticketHolder	Required (if used): identity	Set systematically by Injection Batch	n/a	yes
spectatorDetails.ticketHolder.identity	object		Ticket Holder's identity. (The name "Ticket Holder" might by confusing, this is the person for whom the ticket is held).	spectatorDetails.ticketHolder.identity	Required (if used): firstName,gender,lastName	no	n/a	yes
spectatorDetails.ticketHolder.identity.firstName	string	50 char	Ticket Holder's first name.	spectatorDetails.ticketHolder.identity.firstName	Required	no	n/a	yes
spectatorDetails.ticketHolder.identity.lastName	string	100 char	Ticket Holder's last name.	spectatorDetails.ticketHolder.identity.lastName	Required	no	n/a	yes
spectatorDetails.ticketHolder.identity.gender	string	1 char (m/f/u/x)	Ticket Holder's gender m, f, u or x(For Male, Female, Other, Unknown)	spectatorDetails.ticketHolder.identity.gender	Required	no	n/a	yes
spectatorDetails.ticketHolder.identity.dateOfBirth	string	Date follows RFC 3339 standard	Ticket Holder's birth date.	spectatorDetails.ticketHolder.identity.dateOfBirth		no	n/a	yes
spectatorDetails.ticketHolder.identity.nationality	string	ISO Alpha-2 format	Ticket Holder's nationality.	spectatorDetails.ticketHolder.identity.nationality		no	n/a	yes
spectatorDetails.ticketHolder.identity.passportNumber	string	200 char	Ticket Holder's passport number.	spectatorDetails.ticketHolder.identity.passportNumber		no	n/a	yes
spectatorDetails.ticketHolder.identity.idCardNumber	string	200 char	Ticket Holder's ID card number.	spectatorDetails.ticketHolder.identity.idCardNumber		no	n/a	yes
spectatorDetails.ticketHolder.identity.email	string	256 char	Ticket Holder's email.	spectatorDetails.ticketHolder.identity.email		no	n/a	yes
spectatorDetails.ticketHolder.identity.phoneNumber	string	50 char	Ticket Holder's phone number.	spectatorDetails.ticketHolder.identity.phoneNumber		no	n/a	yes
spectatorDetails.ticketHolder.identity.birthCity	string	50 char	Ticket Holder's birth city.	spectatorDetails.ticketHolder.identity.birthCity		no	n/a	yes
spectatorDetails.ticketHolder.identity.birthCountry	string	ISO Alpha-2 format	Ticket Holder's birth country.	spectatorDetails.ticketHolder.identity.birthCountry		no	n/a	yes
spectatorDetails.ticketHolder.identity.residenceCountry	string	ISO Alpha-2 format	Ticket Holder's residence country.	spectatorDetails.ticketHolder.identity.residenceCountry		no	n/a	yes
spectatorDetails.ticketHolder.identity.address	object		Ticket Holder's address.	spectatorDetails.ticketHolder.identity.address	Required (if used): city,countryCode,line1,zip	no	n/a	yes
spectatorDetails.ticketHolder.identity.address.line1	string	200 char	TIcket Holder's address line 1.	spectatorDetails.ticketHolder.identity.address.line1	Required	no	n/a	yes
spectatorDetails.ticketHolder.identity.address.line2	string	200 char	Ticket Holder's address line 2.	spectatorDetails.ticketHolder.identity.address.line2		no	n/a	yes
spectatorDetails.ticketHolder.identity.address.line3	string	200 char	Ticket Holder's address line 3.	spectatorDetails.ticketHolder.identity.address.line3		no	n/a	yes
spectatorDetails.ticketHolder.identity.address.city	string	200 char	Ticket Holder's residence city.	spectatorDetails.ticketHolder.identity.address.city	Required	no	n/a	yes
spectatorDetails.ticketHolder.identity.address.countryCode	string	200 char	Ticket Holder's country code.	spectatorDetails.ticketHolder.identity.address.countryCode	Required	no	n/a	yes
spectatorDetails.ticketHolder.identity.address.zip	string	50 char	Ticket Holder's zip code.	spectatorDetails.ticketHolder.identity.address.zip	Required	no	n/a	yes
spectatorDetails.ticketHolder.extraInfo1	string	100 char	Free field of extra info about the Ticket Holder.	spectatorDetails.ticketHolder.extraInfo1		no	n/a	yes
spectatorDetails.ticketHolder.extraInfo2	string	100 char	Second free field of extra info about the Ticket Holder.	spectatorDetails.ticketHolder.extraInfo2		no	n/a	yes
spectatorDetails.ticketHolder.reason	string	512 char	Reason of why the assignment happen. Can be modified later by the spectator. (Optional)	spectatorDetails.ticketHolder.reason
spectatorDetails.organizerSpectatorPreference	object		Contains all spectator preferences concerning promo emails and tracking.	spectatorDetails.organizerSpectatorPreference	Required (if used): allowPromoEmail,allowPromoThirdPartyEmail,allowTracking	no	n/a	no
spectatorDetails.organizerSpectatorPreference.allowPromoEmail	boolean	boolean	Default false. Spectator accept promotional email from TIXnGO.	spectatorDetails.organizerSpectatorPreference.allowPromoEmail	Required	no	n/a	yes
spectatorDetails.organizerSpectatorPreference.allowPromoThirdPartyEmail	boolean	boolean	Default false. Spectator accept promotional email from Third-Party.	spectatorDetails.organizerSpectatorPreference.allowPromoThirdPartyEmail	Required	no	n/a	yes
spectatorDetails.organizerSpectatorPreference.allowTracking	boolean	boolean	Default false. Spectator accept to be tracked and data matching.	spectatorDetails.organizerSpectatorPreference.allowTracking	Required	no	n/a	yes
ticketId	string	256 char	Ticket ID differentiating each ticket. It must be unique (UUID).	ticketId	Required	no	n/a	no
lang	string	5 char ISO 639‑1 format	The default language for the Ticket. Injection communications will be sent in this language. Example: fr, en, de, it, es	lang		no	n/a	yes
transferRules	object		All of the Ticket's transfer rules.	transferRules				no
transferRules.groupId	string	256 char	Transfer rules can technically be different for every ticket. Organizer might want to chose to have different transfer rules for different types of ticket (ex: Adult, child, VIP, etc…). This GroupID is the Transfer rules group ID representing a group of transfer rules applied to certain tickets. If Organizers want to apply the same rules to every tickets, by default this groupID is set to the EventID and every ticket will be in this group.	transferRules.groupId		Comfort Variable	TIXRGrp	yes
transferRules.maxNumberOfTransferPerTicketInGroupId	integer	integer	Total amount of transfers per Ticket (-1 feature is disabled).	transferRules.maxNumberOfTransferPerTicketInGroupId		Comfort Variable	TIXRTrTk	yes
transferRules.assignTransferLimit	integer	integer	Define upper bound of ticket's transfer level for the "Assign" function	transferRules.assignTransferLimit
transferRules.allowTransfer	boolean	boolean	Enables or Disables transfer functionality for given match (Send menu item in the ticket view hidden or displayed).	transferRules.allowTransfer		Comfort Variable	TIXRTrn	yes
transferRules.allowTransferMainApplicant	boolean	boolean	Enable or Disable transfer functionnality for Main Applicant ticket's.	transferRules.allowTransferMainApplicant
transferRules.allowTransferAfterActivation	boolean	boolean	Enables or Disables transfer functionality for given match for Activated Tickets (Send menu item in the ticket view hidden or displayed).	transferRules.allowTransferAfterActivation		Comfort Variable	TIXRTrnA	yes
transferRules.allowTransferAfterControl	boolean	boolean	Enables or Disables transfer functionality for given match for Controlled Tickets (Send menu item in the ticket view hidden or displayed).	transferRules.allowTransferAfterControl		no	n/a	yes
transferRules.allowReturnToOrganizer	boolean	boolean	Allow to release ticket to resale / allow ticket shop resale Use TRUE to enable Ticket Resale for this ticket. Use FALSE to disable Ticket Resale for this ticket.	transferRules.allowReturnToOrganizer
transferRules.allowReturnToOrganizerForInitialSpectator	boolean	boolean	Only Initial Spectator can release ticket to resale For this parameter to take effect, “transferRules.allowReturnToOrganizer” must be set to TRUE. Use TRUE to restrict Ticket Resale feature to the initial spectator ONLY Use FALSE to allow any spectator to use the Ticket Resale feature	transferRules.allowReturnToOrganizerForInitialSpectator
transferRules.keepOneInGroupId	boolean	boolean	Force ALL ticket wallet holders to keep at least 1 ticket per given Match.	transferRules.keepOneInGroupId		Comfort Variable	TIXRKp1	yes
transferRules.keepOneAtInjectInGroupId	boolean	boolean	Force ticket wallet holder to whom tickets were originally injected to keep at least 1 ticket per given Match. E.g. all his transfer guests will be able to forward all the tickets they received.	transferRules.keepOneAtInjectInGroupId		Comfort Variable	TIXRKp1I	yes
design.id	string	256 char	The Design Id applies to the ticket.	design.id				no
design.backgroundColor	string	7 char hexadecimal color code	The background color of the corresponding design.	design.backgroundColor				no
ticketInjectionDate	string	Date follows RFC 3339 standard	The date at which the ticket was injected.	ticketInjectionDate		no	n/a	no
mainApplicant	boolean	boolean	Optional Main Applicant flag (SecuTix)	mainApplicant				no
sortingKey	string	256 char	A key to sort the tickets in the spectator view. The tickets will be sorted according to this key in alphabetical order.	sortingKey				no
mobileAppId	string	256 char	Mandatory Mobile Application App Id to use associated invitation email template (used by organizer using their own app or branded apps).	mobileAppId	Required	no	n/a	no
validate	boolean	boolean	Flag to only validate tickets and not injecting them for real. It does not test interraction with the blockchain.	validate		no	n/a	no

Browser not supported