UNTP v0.6.0
UNTP and its reference implementation are pre-release. Interfaces, schemas and data models can change between versions without a deprecation period, so treat anything built against them as provisional.
Overview
This guide outlines:
- The migration from UNTP (UN Transparency Protocol) version 0.5.0 to 0.6.0 across all supported data models in the Reference Implementation. This update introduces structural changes, enhanced schema definitions, improved data validation patterns, and updated JSON-LD contexts.
- Functional updates to the Reference Implementation, including updates to dependent services, credential rendering, and configuration changes.
Functional Updates
Dependent Service Updates
The Reference Implementation now uses the following updated services:
- Storage Service: v1.0.1 (Repository)
- VCkit Service: v1.1.0 (Repository)
- Identity Resolver Service: v1.0.0 (Repository)
The docker-compose configuration has been updated to use the corresponding images for these service versions. Refer to the respective changelogs in each service’s repository for detailed information.
Key Changes for Existing Implementations
-
Storage Service Configuration
The Storage Service configuration URL has been updated:
Previous Configuration:
"storage": {
"url": "http://localhost:3334/v1/documents",
"params": {
"bucket": "verifiable-credentials"
},
"options": {
"method": "POST",
"headers": {
"Content-Type": "application/json"
}
}
}New Configuration:
"storage": {
"url": "http://localhost:3334/api/1.0.0/documents",
"params": {
"bucket": "verifiable-credentials"
},
"options": {
"method": "POST",
"headers": {
"Content-Type": "application/json"
}
}
}Note: The
urlhas changed from/v1/documentsto/api/1.0.0/documents. -
Identity Resolver (IDR) Service Configuration
The IDR Service configuration URL and
linkRegisterPathhave been updated:Previous Configuration:
"dlr": {
"dlrAPIUrl": "http://localhost:3000",
"dlrAPIKey": "test123",
"namespace": "gs1",
"linkRegisterPath": "/api/resolver"
}New Configuration:
"dlr": {
"dlrAPIUrl": "http://localhost:3000/api/1.0.0",
"dlrAPIKey": "test123",
"namespace": "gs1",
"linkRegisterPath": "resolver"
}Note: The
dlrAPIUrlnow includes the/api/1.0.0path, and thelinkRegisterPathno longer has a leading/. -
Identity Provider Configuration (Mock IDR GS1 Register)
The Identity Provider configuration URL has been updated:
Previous Configuration:
"identifyProvider": {
"type": "gs1",
"url": "http://localhost:3001",
"namespace": "gs1"
}New Configuration:
"identifyProvider": {
"type": "gs1",
"url": "http://localhost:3001/api/1.0.0",
"namespace": "gs1"
}Note: The
urlnow includes the/api/1.0.0path.
These URL updates ensure the system remains stable when underlying service API versions change.
Seed Script Updates
The IDR Service and Mock GS1 IDR Service seed scripts have been updated to reflect the new link structure. To ensure compatibility:
- Update any custom or additional seed scripts to align with the new URL structures (
/api/1.0.0). - Clear all data in the corresponding object store (e.g., delete the
minio_datadirectory or reset the cloud-based object store) to ensure the system uses the new URLs.
API versions are now included in the seed scripts. If you are using Docker Compose, this is handled automatically. Otherwise, refer to the seed script section in the repository's README.
VCkit Render Package Update
The @uncefact/vckit-renderer package has been updated from version 1.0.0-next.50 to 1.0.0-next.59.
This update addresses an issue where the previous implementation used malformed IRIs to extract render templates from credentials (see details here). With UNTP v0.6.0 and the updated package, the system now uses valid IRIs for rendering.
Important: Credentials issued with previous versions will no longer render. You must use the v0.6.0 data models for credentials to render correctly with the this latest version of the Reference Implementation.
Data Model Updates
Digital Facility Record (DFR)
Summary of Changes
The main changes for Digital Facility Records in UNTP 0.6.0 include:
- Enhanced validation patterns: The updated schema validations simplify the extension of UNTP credential types.
- Improved identifier structure: Simplified identifier scheme with better organisation and removal of nested
idSchemereferences - Updated JSON-LD contexts: New vocabulary context path structure with improved semantic mappings and vocabulary organisation
- Schema refinements: Better property organisation, improved abstraction, and enhanced data model consistency
- Simplified conformity claim structure: Simplified
issuingPartyin theStandardandadministeredByinRegulationby removing the nestedidSchemeandtypestructure. - Enhanced criterion schema: The
Criterionschema now includesdescription,conformityTopic,status,subCriterion,thresholdValue,performanceLevel, andtags.