Data fields

Every piece of data on a Credential is stored as a named field. Fields are divided into two categories:

• Providable fields (manual_input: true) — values you supply when ordering a Credential via CredentialOrderV1.
• System-populated fields (manual_input: false) — values the system sets automatically (card numbers, RFID data, Tenant info, Number Ranges). You cannot set these when ordering.

Not every Template uses every field. Call CredentialTemplatesV2 to get the exact list of fields a Template requires before ordering. All requests must be authenticated — see Authentication.

---

Providable fields

These fields can be included in the data array when calling CredentialOrderV1. Use the value key that matches the field's type — see type matching.

Person

Name	Type	Description
personFirstName	string	First name
personLastName	string	Last name
personMiddleName	string	Middle name
personFullName	string	Full name (alternative to separate first/last)
personEmail	string	Email address
personPhoneNumber	string	Phone number
personMobilePhoneNumber	string	Mobile phone number
personEmployeeNo	string	Employee number
personPersonalNo	string	Personal identification number
personGender	string	Gender
personCountryCode	string	Two-letter country code (e.g. NO)
personCountry	string	Country name
personEducationCode	string	Education or qualification code
personPin	string	PIN code
personDepartment	string	Department or unit

Company

Name	Type	Description
companyName	string	Name of the issuing company

Card

Name	Type	Description
cardValidUntilDate	date	Credential expiry date
cardNumberManual	string	Manually assigned card number
cardBarcode	string	Barcode value printed on the card

Order

Name	Type	Description
orderCostCentre	string	Cost center for billing purposes
orderPartnerId	string	Partner system identifier

User (ordering user)

Name	Type	Description
userName	string	Name of the user placing the order
userEmail	string	Email of the user placing the order
userPhone	string	Phone of the user placing the order

Delivery address

Used when the Credential should be physically shipped to an address.

Name	Type	Description
addressReceiver	string	Recipient name
addressAttention	string	Attention line (c/o)
addressAddress1	string	Street address line 1
addressAddress2	string	Street address line 2
addressPostCode	string	Postal code
addressCity	string	City
addressCountry	string	Country

Messaging

Name	Type	Description
messageToAccessVendor	string	Message passed to the access control vendor at production time

Custom calculations

String fields that can be used for Template formulas and partner-specific calculated values.

Name	Type
customCalc1–customCalc10	string

Extra fields

Arbitrary string and date fields for partner-specific data not covered by named fields.

Name	Type
extra1–extra31	string
extraDate1–extraDate5	date

---

System-populated fields

These fields are set automatically by Breeze. They are read-only when ordering — values you provide for them will be ignored.

Images

Although these are system-populated in manual form workflows, you can supply image fields via the API using base64_value (Base64-encoded image) or url_value (publicly accessible URL, max 5 MB). The system downloads and stores the image.

Name	Type	Description
personPhoto1	buffer	Primary person photo
personPhoto2	buffer	Secondary person photo
personSignature	buffer	Signature image
companyLogo	buffer	Company logo
companyLogoFront	buffer	Company logo — front of card (auto-sourced from Tenant)
companyLogoBack	buffer	Company logo — back of card (auto-sourced from Tenant)
cardFrontPreview	buffer	Generated preview of the front of the card
cardBackPreview	buffer	Generated preview of the back of the card

Card system fields

Set by Breeze at production time.

Name	Type	Description
cardNumber	string	System-assigned card number
cardSpecId	string	Card specification identifier
cardSpecName	string	Card specification name
cardOrderDate	date	Date the Credential was ordered
credentialNumber	string	Human-readable Credential number (same as credential_number on the Credential type)

Tenant

Automatically populated from the Tenant context.

Name	Type	Description
tenantId	string	Tenant ID
tenantNumber	string	Tenant number
tenantName	string	Tenant name
tenantExternalRef	string	Tenant external reference

Requester

Populated from the authenticated API user.

Name	Type	Description
requesterId	string	ID of the user who placed the order
requesterFirstName	string	First name of the requester
requesterLastName	string	Last name of the requester
requesterEmail	string	Email of the requester
requesterPhone	string	Phone of the requester

Number Ranges

Populated from Number Range configurations on the Template. Three independent ranges are supported.

Name	Type	Description
range1Sequence	string	Range 1 — sequence number
range1FullSequence	string	Range 1 — full formatted sequence
range1VersionNumber	string	Range 1 — version number
range1Prefix	string	Range 1 — prefix
range1Suffix	string	Range 1 — suffix
range1SiteCode	string	Range 1 — site code
range1Formula1–range1Formula3	string	Range 1 — calculated formula outputs
range2Sequence–range2Formula3	string	Range 2 — same set of fields
range3Sequence–range3Formula3	string	Range 3 — same set of fields

Template formulas

Calculated outputs from Template-level formulas.

Name	Type
templateFormula1–templateFormula3	string

RFID card serial number (CSN)

Populated when the Credential is encoded with an RFID chip. Twenty-four format variants covering HF and LF frequencies in different byte orders and vendor encodings.

Name	Description
uidHfHexMsb	HF — Hex MSB
uidHfHexLsb	HF — Hex LSB
uidHfDecMsb	HF — Decimal MSB
uidHfDecLsb	HF — Decimal LSB
uidHfRco	HF — RCO format
uidHfArx	HF — ARX format
uidHfSchneider	HF — Schneider format
uidHfMsb5bDec	HF — 5-byte decimal
uidHfMsbFirst4bDec	HF — first 4 bytes MSB decimal
uidHfMsbLast4bDec	HF — last 4 bytes MSB decimal
uidHfLsbFirst4bDec	HF — first 4 bytes LSB decimal
uidHfLsbLast4bDec	HF — last 4 bytes LSB decimal
uidHfHs24	HF — HS24 format
uidLfHexMsb	LF — Hex MSB
uidLfHexLsb	LF — Hex LSB
uidLfDecMsb	LF — Decimal MSB
uidLfDecLsb	LF — Decimal LSB
uidLfSolid	LF — Solid format
uidLfBewator2010	LF — Bewator 2010
uidLfBewatorEntro	LF — Bewator Entro
uidLfBravida	LF — Bravida format
uidLfRco	LF — RCO format
uidLfH10304	LF — HID Prox H10304
uidLfAxema	LF — Axema format

All RFID fields are string type.

---

Type matching

When providing a field value in the data array, use exactly one value key matching the field's type:

Field type	Value key
string	string_value
number	number_value
boolean	bool_value
date	date_value — ISO 8601 format: 2035-12-31T12:00:00.000Z
buffer	base64_value (Base64-encoded image) or url_value (image URL)

Providing the wrong key for a field's type will return a BAD_USER_INPUT error.

See also

• CredentialOrderV1
• CredentialTemplatesV2