Node Type Aliases
AustralianAddress
Section titled “AustralianAddress”Type alias
AustralianAddress: z.infer<typeof australianAddressSchema>AustralianPiiFields
Section titled “AustralianPiiFields”Type alias
AustralianPiiFields: z.infer<typeof australianPiiFieldsSchema>BarcodeErrorCorrectionLevel
Section titled “BarcodeErrorCorrectionLevel”Type alias
QR error-correction level chosen by the damage-first degradation ladder.
BarcodeErrorCorrectionLevel: "Q" | "M" | "L"BarcodeImage
Section titled “BarcodeImage”Type alias
BarcodeImage: z.infer<typeof barcodeImageSchema>BarcodeLayout
Section titled “BarcodeLayout”Type alias
Badge arrangement: the header above the QR code, or the frame to its right.
BarcodeLayout: "vertical" | "horizontal"BatchRecordStatus
Section titled “BatchRecordStatus”Type alias
Per-record status. Typed as the known statuses plus string so a future
API status flows through to your handling untouched while autocomplete
still offers the known values.
BatchRecordStatus: KnownBatchRecordStatus | string & objectEncryptionMetadata
Section titled “EncryptionMetadata”Type alias
EncryptionMetadata: z.infer<typeof encryptionMetadataSchema>KnownBatchRecordStatus
Section titled “KnownBatchRecordStatus”Type alias
KnownBatchRecordStatus: typeof KNOWN_BATCH_RECORD_STATUSES[number]KnownSchemaRegisterNonPiiBatchRequest
Section titled “KnownSchemaRegisterNonPiiBatchRequest”Type alias
Opt-in typed batch input for the payslip schemas currently known to this SDK.
KnownSchemaRegisterNonPiiBatchRequest: z.input<typeof registerNonPiiBatchRequestSchema>KnownVerifiablErrorCode
Section titled “KnownVerifiablErrorCode”Type alias
KnownVerifiablErrorCode: typeof KNOWN_VERIFIABL_ERROR_CODES[number]NewZealandAddress
Section titled “NewZealandAddress”Type alias
NewZealandAddress: z.infer<typeof newZealandAddressSchema>NewZealandPiiFields
Section titled “NewZealandPiiFields”Type alias
NewZealandPiiFields: z.infer<typeof newZealandPiiFieldsSchema>PayslipNonPii
Section titled “PayslipNonPii”Type alias
PayslipNonPii: z.infer<typeof payslipNonPiiSchema>PiiFieldName
Section titled “PiiFieldName”Type alias
PiiFieldName: typeof PII_FIELD_ORDER[number] | typeof AUSTRALIAN_PII_FIELD_ORDER[number] | typeof NEW_ZEALAND_PII_FIELD_ORDER[number]PiiFields
Section titled “PiiFields”Type alias
PiiFields: z.infer<typeof piiFieldsSchema>PiiFieldViolationReason
Section titled “PiiFieldViolationReason”Type alias
Why a PII field value cannot be encoded in the PII wire format.
PiiFieldViolationReason: "pipe" | "control-character" | "format-character" | "invalid-unicode"QrCapacityFailureReason
Section titled “QrCapacityFailureReason”Type alias
Which capacity limit the QR content exceeded.
qr-capacity: the content is longer than any QR version holds, at any error-correction level. A wider badge does not help.frame-fit: the content encodes, but only into a symbol whose modules fall below the scannable floor inside the fixed frame at this width. A wider badge can carry it.
QrCapacityFailureReason: "qr-capacity" | "frame-fit"RegisterAndBuildBarcodeRequest
Section titled “RegisterAndBuildBarcodeRequest”Type alias
RegisterAndBuildBarcodeRequest: z.input<typeof registerAndBuildBarcodeRequestSchema>RegisterAndBuildBarcodeResponse
Section titled “RegisterAndBuildBarcodeResponse”Type alias
RegisterAndBuildBarcodeResponse: z.infer<typeof registerAndBuildBarcodeResponseSchema>RegisterNonPiiBatchRequest
Section titled “RegisterNonPiiBatchRequest”Type alias
Batch input accepts future schema ids and invalid payslips for per-record error reporting.
RegisterNonPiiBatchRequest: z.input<typeof registerNonPiiBatchEnvelopeSchema>RegisterNonPiiRequest
Section titled “RegisterNonPiiRequest”Type alias
RegisterNonPiiRequest: z.input<typeof registerNonPiiRequestSchema>RegisterNonPiiResponse
Section titled “RegisterNonPiiResponse”Type alias
RegisterNonPiiResponse: z.infer<typeof registerNonPiiResponseSchema>SupportedHorizontalPngPixelWidth
Section titled “SupportedHorizontalPngPixelWidth”Type alias
SupportedHorizontalPngPixelWidth: typeof SUPPORTED_HORIZONTAL_PNG_PIXEL_WIDTHS[number]SupportedPngPixelWidth
Section titled “SupportedPngPixelWidth”Type alias
SupportedPngPixelWidth: typeof SUPPORTED_PNG_PIXEL_WIDTHS[number]VerifiablEnvironment
Section titled “VerifiablEnvironment”Type alias
VerifiablEnvironment: "production" | "sandbox"VerifiablErrorBody
Section titled “VerifiablErrorBody”Type alias
VerifiablErrorBody: z.output<typeof verifiablErrorBodySchema>VerifiablErrorCode
Section titled “VerifiablErrorCode”Type alias
Stable machine-readable error code. Typed as the known codes plus
string so future API codes flow through to your error handling
untouched while autocomplete still offers the known values.
VerifiablErrorCode: KnownVerifiablErrorCode | string & objectVerifiablErrorDetail
Section titled “VerifiablErrorDetail”Type alias
VerifiablErrorDetail: z.infer<typeof verifiablErrorDetailSchema>