untp-core
version: 0.2.3
untp-core Domain
Data Model
Data Definitions
VerifiableCredential
A verifiable credential is a digital and verifiable version of everyday credentials such as certificates and licenses. It conforms to the W3C Verifiable Credentials Data Model v2.0 (VCDM).
| Property | Definition | Type |
|---|---|---|
| @context | A list of JSON-LD contect URIs that define the seamntic meaning of prperties within the credential. | Text |
| id | A unique identifier (URI) assigned to the product passport. May be a UUID | URI |
| issuer | The organisation that is the isuer of this VC. Note that the "id" property MUST be a W3C DID. Other identifiers such as tax registration numbers can be listed in the "otherIdentifiers" property. | Party |
| validFrom | The date and time from which the credential is valid. | DateTime |
| validUntil | The expiry date (if applicable) of this verifiable credential. | DateTime |
Identifier
An identifier of a party, product, or facility that is defined by an identifier scheme and idenfier value.
| Property | Definition | Type |
|---|---|---|
| id | A linked data URL for the entity (product, facility, or organisation) that is identified by this identifier - eg https://abr.business.gov.au/ABN/View?abn=90664869327 | URI |
| idScheme | the identifier scheme as defined by the registrar that manages the identifier registry. Eg abr.busines.gov.au If the identifier scheme is registered with UNTP then this URI can use used to dicsover the resolution method (to get more data) and the verification method (to prove ownership). | URI |
| idSchemeName | The identifier scheme name (eg Australian Business Number or GS1 Global Trade Item Number)) | Text |
| idValue | The value of the identifier within the scheme (eg 90664869327) | Text |
| name | The name of the identified entity. | Text |
Party
An organisation. May be a supply chain actor, a certifier, a government agency.
| Property | Definition | Type |
|---|---|---|
| id | A linked data URL for the entity (product, facility, or organisation) that is identified by this identifier - eg https://abr.business.gov.au/ABN/View?abn=90664869327 | URI |
| idScheme | the identifier scheme as defined by the registrar that manages the identifier registry. Eg abr.busines.gov.au If the identifier scheme is registered with UNTP then this URI can use used to dicsover the resolution method (to get more data) and the verification method (to prove ownership). | URI |
| idSchemeName | The identifier scheme name (eg Australian Business Number or GS1 Global Trade Item Number)) | Text |
| idValue | The value of the identifier within the scheme (eg 90664869327) | Text |
| name | The name of the identified entity. | Text |
| registrationCountry | the country in which this organisation is registered | Code (countryCode) |
| organisationWebsite | Website for this organisation | URI |
| industryCategory | The industry categories for this organisations. Recommend use of UNCPC as the category scheme. | Classification |
| otherIdentifiers | An optional lsit of other registered identifiers for this organisations | Identifier |
Facility
The physical site (eg farm or factory) where the product or materials was produced.
| Property | Definition | Type |
|---|---|---|
| id | A linked data URL for the entity (product, facility, or organisation) that is identified by this identifier - eg https://abr.business.gov.au/ABN/View?abn=90664869327 | URI |
| idScheme | the identifier scheme as defined by the registrar that manages the identifier registry. Eg abr.busines.gov.au If the identifier scheme is registered with UNTP then this URI can use used to dicsover the resolution method (to get more data) and the verification method (to prove ownership). | URI |
| idSchemeName | The identifier scheme name (eg Australian Business Number or GS1 Global Trade Item Number)) | Text |
| idValue | The value of the identifier within the scheme (eg 90664869327) | Text |
| name | The name of the identified entity. | Text |
| countryOfOperation | The country in which this facility is operating. | Code (countryCode) |
| processCategory | The idustrial or production processes performed by this facility. | Classification |
| operatedByParty | The Party entity responsible for operating the facility. | Identifier |
| otherIdentifiers | An optional list of other registered identifiers for this facility | Identifier |
| locationInformation | Geolocation and address information for this facility | Location |
Location
Location information including address and geolocation of points, areas, and boundaries
| Property | Definition | Type |
|---|---|---|
| id | A linked data URL for the entity (product, facility, or organisation) that is identified by this identifier - eg https://abr.business.gov.au/ABN/View?abn=90664869327 | URI |
| idScheme | the identifier scheme as defined by the registrar that manages the identifier registry. Eg abr.busines.gov.au If the identifier scheme is registered with UNTP then this URI can use used to dicsover the resolution method (to get more data) and the verification method (to prove ownership). | URI |
| idSchemeName | The identifier scheme name (eg Australian Business Number or GS1 Global Trade Item Number)) | Text |
| idValue | The value of the identifier within the scheme (eg 90664869327) | Text |
| name | The name of the identified entity. | Text |
| areaReference | The area of the facility as a URI - typically a plus code (see https://maps.google.com/pluscodes/) | URI |
| geoLocation | The latitude and logditude coordinates that best represent the specified location | Coordinate |
| boundary | The list of coordinates that define a closed area polygon as a location boundary. | Coordinate |
| postalAddress | The textual address of the location. | PostalAddress |
Coordinate
A map coordinate defined by a lattitude & longditude pair.
| Property | Definition | Type |
|---|---|---|
| Latitude | The latitude of a map location expressed in decimal degrees (between +90 and -90) where negative values represent latitudes south of the equator. | Decimal |
| Longditude | The longditude of a map location expressed in decimal degrees (between +180 and -180) where negative values represent longditudes west of the prime meridian. | Decimal |
Product
The ProductInformation class encapsulates detailed information regarding a specific product, including its identification details, manufacturer, and other pertinent details.
| Property | Definition | Type |
|---|---|---|
| id | A linked data URL for the entity (product, facility, or organisation) that is identified by this identifier - eg https://abr.business.gov.au/ABN/View?abn=90664869327 | URI |
| idScheme | the identifier scheme as defined by the registrar that manages the identifier registry. Eg abr.busines.gov.au If the identifier scheme is registered with UNTP then this URI can use used to dicsover the resolution method (to get more data) and the verification method (to prove ownership). | URI |
| idSchemeName | The identifier scheme name (eg Australian Business Number or GS1 Global Trade Item Number)) | Text |
| idValue | The value of the identifier within the scheme (eg 90664869327) | Text |
| name | The name of the identified entity. | Text |
| serialNumber | An array of identifiers representing a specific serialised item of the product. | Text |
| batchNumber | Information regarding the specific production batch of the product. | Text |
| productImage | A unique identifier (URI) pointing to an image of the product. | BinaryFile |
| description | A textual description providing details about the product. | Text |
| productCategory | A code representing the product's class, typically using the UN CPC (United Nations Central Product Classification) https://unstats.un.org/unsd/classifications/Econ/cpc | Classification |
| furtherInformation | A URL pointing to further human readable information about the product. | URI |
| producedByParty | The Party entity that manufactured the product. | Identifier |
| producedAtFacility | The Facility where the product batch was produced / manufactured. | Identifier |
| dimensions | The physical dimensions of the product. Not every dimension is relevant to every products. For example bulk materials may have wieght and volume but not length, with, or height. | Dimension |
| productionDate | The ISO 8601 date on which the product batch was manufactured. | Date |
| countryOfProduction | The country in which this item was produced / manufactured. | Code (countryCode) |
Classification
A classification scheme and code / name representing a category value for a product, entity, or facility.
| Property | Definition | Type |
|---|---|---|
| id | The globally unique URI representing the specific classifier value - for example https://vocabulary.uncefact.org/unlocode?country=au#AUSYD is the gloabl URI representing the UN/LOCODE for Sydney Australia. | URI |
| classificationSchemeID | Classification scheme - eg https://unstats.un.org/unsd/classifications/Econ/cpc | URI |
| classificationSchemeName | The name of the classificaiotn schema - eg United Nations Central Product Classification | Text |
| classifierValue | classifier value within the scheme - eg "01211" in UN CPC | Text |
| classifierName | Name of the classifier - eg "Asparagus" for code "01211" in UNCPC | Text |
Metric
A specific measure of performance against the criteria that governs the claim. Expressed as an array of metric (ie unit of emasure) / value (ie the actual numeric value) pairs.
| Property | Definition | Type |
|---|---|---|
| metricName | A human readable name for this metric (for example "Tensile strength") | Text |
| metricValue | A numeric value and unit of measure for this metric. Could be a measured value or a specified threshold. | Measure |
| accuracy | A percentage represented as a numeric between 0 and 1 indicating the rage of accuracy of the claimed value (eg 0.05 means that the actual value is within 5% of the claimed value.) | Numeric |
Dimension
Overall (length, width, height) dimensions and weight/volume of an item.
| Property | Definition | Type |
|---|---|---|
| weight | the weight of the product | Measure |
| length | The length of the product or packaging | Measure |
| width | The width of the product or packaging | Measure |
| height | The height of the product or packaging | Measure |
| volume | The displacement volume of the product. | Measure |
Measure
The measure class defines a numeric measured value (eg 10) and a coded unit of measure (eg KG).
| Property | Definition | Type |
|---|---|---|
| value | The numeric value of the measure | Numeric |
| unit | Unit of measure drawn from the UNECE rec20 measure code list. | Code (unitOfMeasure) |
BinaryFile
A file representing a data snapshot that is used to infomr the conformity assessment.
| Property | Definition | Type |
|---|---|---|
| id | GLobally unique ID for the binary file - usually it's location as a URL. | URI |
| fileName | A name for referenced binary file | Text |
| fileType | The type of file, represented as a MIME type. | Code (mimeType) |
SecureBinaryFile
A binary file that is hashed ()for tamper evidence) and optionally encrypted (for confidentiality).
| Property | Definition | Type |
|---|---|---|
| id | GLobally unique ID for the binary file - usually it's location as a URL. | URI |
| fileName | A name for referenced binary file | Text |
| fileType | The type of file, represented as a MIME type. | Code (mimeType) |
| fileHash | The MD5 hash of the file. | Text |
| hashMethod | The hashing algorithm used to create the file hash. SHA-265 is the recommedned standard | Code (hashMethodCode) |
| encryptionMethod | The symmetric encryption algorithm used to encrypt this binary file. AES is the recommended standard | Code (encryptionMethodCode) |
Declaration
A specific assessment about the product or facility against a specific specification. Eg the carbon intensity of a given product or batch.
| Property | Definition | Type |
|---|---|---|
| id | A unique identifier for the standard (eg https://www.iso.org/standard/60857.html). | URI |
| referenceStandard | The reference to the standard that defines the specification / criteria | Standard |
| referenceRegulation | The reference to the regulation that defines the assessment criteria | Regulation |
| assessmentCriterion | The specification against which the assessment is made. | Criteria |
| declaredValues | The list of specific values measured as part of this assessment (eg tensile strength) | Metric |
| compliance | An indicator of whether or not the assessment meets the specification. | Indicator |
| conformityTopic | The conformity topic category for this assessment (eg vocabulary.uncefact.org/sustainability/emissions) | Code (conformityTopicCode) |
Standard
A standard (eg ISO 14000) that specifies the criteria for conformance.
| Property | Definition | Type |
|---|---|---|
| id | A linked data URL for the entity (product, facility, or organisation) that is identified by this identifier - eg https://abr.business.gov.au/ABN/View?abn=90664869327 | URI |
| idScheme | the identifier scheme as defined by the registrar that manages the identifier registry. Eg abr.busines.gov.au If the identifier scheme is registered with UNTP then this URI can use used to dicsover the resolution method (to get more data) and the verification method (to prove ownership). | URI |
| idSchemeName | The identifier scheme name (eg Australian Business Number or GS1 Global Trade Item Number)) | Text |
| idValue | The value of the identifier within the scheme (eg 90664869327) | Text |
| name | The name of the identified entity. | Text |
| issuingParty | The party that issued the standard (ID and Name reference only) | Identifier |
| issueDate | The date when the standard was issued. | Date |
Regulation
A regulation (eg EU deforestation regulation) that defines the criteria for assessment.
| Property | Definition | Type |
|---|---|---|
| id | A linked data URL for the entity (product, facility, or organisation) that is identified by this identifier - eg https://abr.business.gov.au/ABN/View?abn=90664869327 | URI |
| idScheme | the identifier scheme as defined by the registrar that manages the identifier registry. Eg abr.busines.gov.au If the identifier scheme is registered with UNTP then this URI can use used to dicsover the resolution method (to get more data) and the verification method (to prove ownership). | URI |
| idSchemeName | The identifier scheme name (eg Australian Business Number or GS1 Global Trade Item Number)) | Text |
| idValue | The value of the identifier within the scheme (eg 90664869327) | Text |
| name | The name of the identified entity. | Text |
| issuingParty | the issuing body of the regulation. | Identifier |
| effectiveDate | the date at which the regulation came into effect. | Date |
Criteria
A specific rule or criterion within a standard or regulation. eg a carbon intensity calculation rule within an emissions standard.
| Property | Definition | Type |
|---|---|---|
| id | A unique identifier for the criterion - managed by the standards uthority or regulator. | URI |
| criteriaName | A name that describes this criteria (eg tensile strength) | Text |
| thresholdValues | A conformity threshold defined by the specification (eg minimum compressive strength) | Metric |
Material
The material class encapsulates details about the origin or source of raw materials in a product, including the country of origin and the mass fraction.
| Property | Definition | Type |
|---|---|---|
| MaterialName | Name of this material (eg "Egyptian Cotton") | Text |
| originCountry | A ISO 3166-1 code representing the country of origin of the component or ingredient. | Code (countryCode) |
| materialType | The type of this material - as a value drawn from a controlled vocabulary eg textileexchange.org/materials/rm01014 - representing organic cotton. | Classification |
| massFraction | A numeric value representing the mass fraction of the product represented by this material. The sum of all mass fraction values for a given passport should be 100. | Numeric |
| recycledAmount | Percentage of this material that is recycled (eg 80% recycled Cotton) | Numeric |
| hazardous | Indicates whether this material is hazardous. If true then the materialSafetyInformation proerty must be present | Indicator |
| materialSafetyInformation | Refernece to further information obout safe handling of this hazardous material (for example a link to a material safety data sheet) | URI |
Circularity
High level corcularity information about this product. Note that this doens not substitute for detailed product circularity data sheet (PCDS) criteria which would be represented as a set of conformity claims against individual ISO PCDS criteria.
| Property | Definition | Type |
|---|---|---|
| recyclingInformation | A URI pointing to recycling information for the product. | URI |
| repairInformation | A URI pointing to repair instructions for this product. | URI |
| recyclableContent | The percentage of the this product (my mass) that has been designed to be recyclable. | Decimal |
| recyecledContent | The percentage (by mass) of recycled content in this product | Decimal |
Characteristic
Product specific characteristics. This class is an extension point for industry specific product characteristics or performance information such as clothing size or battery capacity.
| Property | Definition | Type |
|---|
Attestation
A conformity attestation issued by a competent body that defines one or more assessments (eg carbon intensity) about a product (eg batttery) against a specification (eg LCA method) defined in a standard or regulation.
| Property | Definition | Type |
|---|---|---|
| id | The globally unique ID of this conformity attestation. | URI |
| assessorLevel | Assurance code pertaining to assessor (relation to the object under assessment) | Code (assessorAssuranceCode) |
| assessmentLevel | Assurance pertaining to assessment (any authority or support for the assessment process) | Code (assessmentAssuranceCode) |
| attestationType | The type of criterion (optional or mandatory). | Code (attestationTypeCode) |
| attestationDescription | A textual description of the scope or purpose of this confomrity attestation | Text |
| issuedToParty | The party to whom the conformity attestation was issued. | Identifier |
| accreditation | The accreditation from a competent authority (ag NATA) that confirms the issuers authorised scope of assessments. | Endorsement |
| conformityCertificate | A reference to the human / printable version of this conformity attestation - typically represented as a PDF document. The document may have more details than are represented in the digital attestation. | BinaryFile |
| auditableEvidence | Auditable evidence supporting this assessment such as raw measurements, supporting documents. This is usally private data and would normally be encrypted. | SecureBinaryFile |
Endorsement
The authority under which a conformity claim is issued. For example a national accrediation authority may accredit a test lab to issue test certificates about a product against a standard.
| Property | Definition | Type |
|---|---|---|
| id | A linked data URL for the entity (product, facility, or organisation) that is identified by this identifier - eg https://abr.business.gov.au/ABN/View?abn=90664869327 | URI |
| idScheme | the identifier scheme as defined by the registrar that manages the identifier registry. Eg abr.busines.gov.au If the identifier scheme is registered with UNTP then this URI can use used to dicsover the resolution method (to get more data) and the verification method (to prove ownership). | URI |
| idSchemeName | The identifier scheme name (eg Australian Business Number or GS1 Global Trade Item Number)) | Text |
| idValue | The value of the identifier within the scheme (eg 90664869327) | Text |
| name | The name of the identified entity. | Text |
| trustmark | The trust mark image awarded by the AB to the CAB to indicate accrediation. | BinaryFile |
| issuingAuthority | The competent authority that issued the accreditation. | Identifier |
| accreditationCertificate | The evidence that supports the authroty under which the attestation is issued - eg an accreditation certificate. | URI |
Code Tables
assessmentAssuranceCode
| Name | Description |
|---|---|
| GovtApproval | conformity assessment delivered under authority granted by national government |
| GlobalMLA | conformity assessment delivered under authority granted by IAF/ILAC signatory body |
| Accredited | conformity assessment delivered under an independent accreditation |
| Verified | conformity assessment externally verified |
| Validated | conformity assessment externally validated |
| Unspecified | conformity assessment claiming no external authority or else unspecified |
assessorAssuranceCode
Code that describes the assurance level of the conformity assessment
| Name | Description |
|---|---|
| Self | self-assessment |
| Commercial | conformity assessment by related body or under commercial contract |
| Buyer | conformity assessment by potential purchaser |
| Membership | conformity assessment by industry representative body or membership body |
| Unspecified | conformity assessment by party with unspecified relationship |
| 3rdParty | 3rd party (independent) conformity assessment |
attestationTypeCode
A code for the type of the attestation credential
| Code | Description |
|---|---|
| certification | A formal third party certification of conformity |
| declaration | A self assessed declaration of conformity |
| inspection | An Inspection report |
| testing | A test report |
| verification | A verification report |
| validation | A validation report |
| calibration | An equipment calibration report |
conformityTopicCode
A high level category scheme for product and facility conformity declarations (claims or attestations)
| Name | Description |
|---|---|
| environment.energy | claims supporting clean energy transition |
| environment.emissions | claims supporting GHG emissions reduction |
| environment.water | claims supporting minimising water usage impact |
| environment.waste | claims supporting waste processing and reduction |
| environment.deforestation | claims supporting native forest restoration |
| environment.biodiversity | claims supporting improved biodiversity outcomes |
| circularity.content | claims supporting the use of recycled content in products |
| circularity.design | claims supporting product design for circularity outcomes |
| social.labour | claims supporting labour rights including fair wages |
| social.rights | claims supporting human rights and anti-discrimination |
| social.community | claims supporting local community development |
| social.safety | claims supporting process and product safety |
| governance.ethics | claims supporting ethical conduct and corporate governance |
| governance.compliance | claims supporting regulatory compliance including taxation and community protection |
| governance.transparency | claims supporting transparency and traceability |
countryCode
Country code list.
Code values for this table can be found here:
https://vocabulary.uncefact.org/CountryId
encryptionMethodCode
| Name | Value | Description |
|---|---|---|
| none | no encryption | |
| AES | AES standard |
hashMethodCode
| Name | Value | Description |
|---|---|---|
| SHA-256 | Secure Hash Algorithm 256 bits |
mimeType
Code values for this table can be found here:
https://mimetype.io/all-types
unitOfMeasure
UNECE Recommendation 20 Unit of Measure codelist
Code values for this table can be found here:
https://vocabulary.uncefact.org/UnitMeasureCode
Imported Domains
- [gs1] - gs1/vocabulary:0.0.1
- [schemaorg] - schemaorg/schema:0.0.1