Skip to content

Optional Configurations

This article outlines all the possible configurations for the credential verification service.

A minimal configuration example which only include required parameters are provided in the Installation article.

{
  "port": 9202, // (1)!
  "baseUrl": "http://localhost:9202", // (2)!
  "ensureHolderBinding": false, // (3)!
  "registry": { // (4)!
    "baseUrl": "https://node1.testnet.partisiablockchain.com",
    "shards": 3,
    "addresses": {
      "registry": "027f3a703fe38cf0525ceaaa3815ffb4140efd8d9a"
    }
  },
  "state": { // (5)!
    "baseUrl": "https://node1.testnet.partisiablockchain.com",
    "privateKey": "348571a75bcb4f4adf169fe5a1c8f03af29b42435a7854d77fb873964f3fd9c1",
    "shards": 3,
    "addresses": {
      "stateContract": "020c713814647a946ec5677c91faaab5c25c46a613"
    }
  },
  "claims": { // (6)!
    "destinationUrl": "https://example-application.com/verified-claims",
    "bearerToken": "5I90CwXlZoolopOSplVBOoV63qXSTEo4piJKJ0iizFau79HU6viEvzgGReWycN8V"
  },
  "clientMetadata": { // (7)!
    "clientName": "Verifier backend name",
    "logoFile": "conf/static/logo.png"
  }
}
  1. REST endpoint port to access the service.
  2. The url of the credential verification service. This is required for the verifier to handle communication with the wallet.
  3. Configure if the verifier should enforce holder binding in credentials - default value is false.
  4. Configures which blockchain registry should be used.
    • For a full explanation of this field go here
  5. Configures which blockchain should be used to store the verification states.
    • For a full explanation of this field go here
  6. Configures where the verified claims should be pushed.
    • For a full explanation of this field go here
  7. Information about the verifier to be presented to the wallet
    • For a full explanation of these fields go here

Client metadata

This section covers parameters used to improve the end-user experience by providing additional and more meaningful information during consents.

  "clientMetadata": {
    "clientName": "Verifier backend",
    "logoFile": "conf/static/partisia-logo.png"
  }
  1. Name of the verifier. This value may be presented to the end user.
  2. Path to a file within the docker container. This image is exposed through the static endpoint http://localhost:9202/static/logo for wallets to fetch.

Warning

If the clientMetadata.logoFile configuration is used, it is important that an image is volume-mounted on the specificied location within the docker container.