Process Digital Facility Record

info

Please note that this content is under development and is not ready for implementation. This status message will be updated as content development progresses.

Description

The processDigitalFacilityRecord service is responsible for processing a digital facility record, issuing a Verifiable Credential (VC), uploading it to the Storage service, registering the link to the stored digital identity anchor with the Identity Resolver service. It handles the entire lifecycle of creating and managing a digital facility record, from data input to storage and resolution.

Diagram

Example

{
  "name": "processDigitalFacilityRecord",
  "parameters": [
    {
      "vckit": {
        "vckitAPIUrl": "http://localhost:3332/v2",
        "issuer": "did:web:uncefact.github.io:project-vckit:test-and-development",
        "headers": {
          "Authorization": "Bearer test123"
        }
      },
      "digitalFacilityRecord": {
        "context": ["https://www.w3.org/2018/credentials/v1", "https://gs1.org/voc/"],
        "type": ["DigitalFacilityRecord"],
        "renderTemplate": [
          {
            "template": "<div><h2>DigitalFacilityRecord</h2></div>",
            "@type": "WebRenderingTemplate2022"
          }
        ],
        "dlrIdentificationKeyType": "gln",
        "dlrLinkTitle": "DigitalFacilityRecord",
        "dlrVerificationPage": "https://verify.example.com"
      },
      "storage": {
        "url": "http://localhost:3334/v1/documents",
        "params": {
          "resultPath": "/uri",
          "bucket": "verifiable-credentials"
        },
        "options": {
          "method": "POST",
          "headers": {
            "Content-Type": "application/json"
          }
        }
      },
      "dlr": {
        "dlrAPIUrl": "https://dlr.example.com/api",
        "dlrAPIKey": "dlr-api-key-12345",
        "namespace": "gs1",
        "linkRegisterPath": "/api/resolver"
      },
      "identifierKeyPath": "/id"
    }
  ]
}

Definitions

Property	Required	Description	Type
vckit	Yes	Configuration for the VCKit service	VCKit
digitalFacilityRecord	Yes	Configuration for the Digital Facility Record	Credential
storage	Yes	Configuration for storage service	Storage
dlr	Yes	Configuration for the Digital Link Resolver	IDR
identifierKeyPath	Yes	JSON path to the identifier in the credential subject or the object for function and arguments of JSON path to construct identifier	IdentifierKeyPath