Skip to main content
Identity is used to define a code for a specific context.

Schema ID

https://gobl.org/draft-0/org/identity

Properties

TitlePropertyTypeDescription
UUIDuuidstringUniversally Unique Identifier.
LabellabelstringOptional label useful for non-standard identities to give a bit more context.
Scopescopecbc.KeyScope defines the context in which this identity is meant to be used.
Countrycountryl10n.ISOCountryCodeCountry from which the identity was issued.
Keykeycbc.KeyUniquely classify this identity using a key instead of a Type.
Typetypecbc.CodeThe type of Code being represented and usually specific for a particular context, country, or tax regime, and cannot be used alongside the key.
Codecodecbc.CodeThe actual value of the identity code.
DescriptiondescriptionstringDescription adds details about what the code could mean or imply
Extensionsexttax.ExtensionsExt provides a way to add additional information to the identity.

Scope Values

ValueDescription
taxTax
legalLegal

Validation Rules

FieldTestValidation Code / Message
Identity
  • Key and type must not be used together
GOBL-ORG-IDENTITY-03
Identity must have either a key or type defined, but not both
code
  • Present
GOBL-ORG-IDENTITY-01
Identity code must be provided
scope
  • One of [tax, legal]
GOBL-ORG-IDENTITY-02
Identity scope when provided must be either ‘tax’ or ‘legal’