Skip to main content
Header defines the metadata of the body.

Schema ID

https://gobl.org/draft-0/head/header

Properties

TitlePropertyTypeDescription
UUIDuuidstringUnique UUIDv1 identifier for the envelope.
Digestdigdsig.DigestDigest of the canonical JSON body.
Stampsstampsarray of head.StampSeals of approval from other organisations that can only be added to non-draft envelopes.
Linkslinksarray of head.LinkLinks provide URLs to other resources that are related to this envelope and unlike stamps can be added even in the draft state.
Tagstagsarray of stringSet of labels that describe but have no influence on the data.
Metametacbc.MetaAdditional semi-structured information about this envelope.
NotesnotesstringAny information that may be relevant to other humans about this envelope

Validation Rules

FieldTestValidation Code / Message
uuid
  • Present
  • Has timestamp
GOBL-HEAD-HEADER-01
Header must contain a UUID v1 or v7 with timestamp
dig
  • Present
GOBL-HEAD-HEADER-02
Header must have a digest
stamps
  • No duplicate stamps
GOBL-HEAD-HEADER-03
Duplicate stamp providers are not allowed
links
  • No duplicate links
GOBL-HEAD-HEADER-04
Duplicate link keys are not allowed