Agent > WellKnown

Retrieve information about credential types and configurations

get

Endpoint facilitates the retrieval of a list of credentials that can be issued based on the provided correlationId. This endpoint expects the correlationId to be passed as a path parameter. Upon receiving a request, the server searches for JSON files located in the /dev/oid4vci_metadata directory, matching the correlationId with the correlationId property in the JSON files. It also returns metadata, which has fields credential_issuer (tells web address where issuer is located) and credential_endpoint (tells web address endpoint where credential can be claimed). It also returns display object and credential_supplier_configobject. display field name will be displayed in wallet app as Authority Name when accepting a credential. Object credential_supplier_config returns all templates and mappings for the credential supplier.

Path parameters

correlationIdstringRequired

Defines a organisation which is defined as a correlationId. Must be a value the Issuer is working with!

Example: teranode

Responses

200Success

application/json

404Error

500Error

get

HTTPcURLJavaScriptPython

GET /api/v1/agent/{correlationId}/.well-known/openid-credential-issuer HTTP/1.1
Host: {ISSUER_API_BASE_URL}
Accept: */*

{
  "credential_issuer": "https://{server-url/ip}/public/{correlation-id}",
  "credential_endpoint": "https://{server-url/ip}/public/{correlation-id}/credentials",
  "token_endpoint": "https://{server-url/ip}/public/{correlation-id}/token",
  "display": {
    "name": "Organisation Issuer",
    "description": "Organisation Issuer"
  },
  "credential_configurations_supported": {
    "ANY_ADDITIONAL_PROPERTY": {
      "display": [
        {
          "name": "Email Credential",
          "description": "Email Credential for Organisation",
          "background_image": {
            "url": "https://cloudfront.example.com/some-path/1/emailCredential"
          }
        }
      ],
      "order": [
        "name-of-claim"
      ],
      "format": "jwt_vc_json",
      "cryptographic_binding_methods_supported": [
        "did:bsv"
      ],
      "credential_signing_alg_values_supported": [
        "ES256K"
      ],
      "credential_definition": {
        "type": [
          "UniqueCredential",
          "VerifiableCredential"
        ],
        "credentialSubject": {
          "name-of-claim": {
            "value_type": "string",
            "mandatory": true,
            "format": "email",
            "display": [
              {
                "name-of-claim-display-value": "Email"
              }
            ]
          }
        }
      }
    }
  },
  "credential_supplier_config": {
    "templates_base_dir": "templates/org-id",
    "template_mappings": [
      {
        "type": [
          "UniqueCredential",
          "VerifiableCredential"
        ],
        "credentialSubject": {
          "name-of-claim": {
            "value_type": "string",
            "mandatory": true,
            "format": "email",
            "display": [
              {
                "name-of-claim-display-value": "Email"
              }
            ]
          }
        }
      }
    ]
  }
}