Schema ID
https://gobl.org/draft-0/head/header
Properties
| Title | Property | Type | Description |
|---|---|---|---|
| UUID | uuid | string | Unique UUIDv1 identifier for the envelope. |
| Digest | dig | dsig.Digest | Digest of the canonical JSON body. |
| Stamps | stamps | array of head.Stamp | Seals of approval from other organisations that can only be added to non-draft envelopes. |
| Links | links | array of head.Link | Links provide URLs to other resources that are related to this envelope and unlike stamps can be added even in the draft state. |
| Tags | tags | array of string | Set of labels that describe but have no influence on the data. |
| Meta | meta | cbc.Meta | Additional semi-structured information about this envelope. |
| Notes | notes | string | Any information that may be relevant to other humans about this envelope |
| From | from | cbc.URI | From is the URI-form transport address of the envelope’s issuer, e.g. “gobl:samlown.example.com” or “iso6523-actorid-upis::9920:b123123123”. |
| To | to | cbc.URI | To is the URI-form transport address of the envelope’s intended receiver. |
| Ignore | ignore | array of string | Ignore lists fully-qualified validation fault codes to suppress when validating this envelope, e.g. “GOBL-EU-EN16931-ORG-ITEM-01”. Intended for format-conversion cases where a specific, known fault is acceptable. Covered by the envelope signature when sealed. NOTE: any code may be listed, including structural envelope/header codes — use deliberately. |
Validation Rules
| Field | Test | Validation Code / Message |
|---|---|---|
uuid |
| GOBL-HEAD-HEADER-01Header must contain a UUID v1 or v7 with timestamp |
dig |
| GOBL-HEAD-HEADER-02Header must have a digest |
stamps |
| GOBL-HEAD-HEADER-03Duplicate stamp providers are not allowed |
links |
| GOBL-HEAD-HEADER-04Duplicate link keys are not allowed |