Skip to main content

API

/.well-known/openid-credential-issuer

get

A public endpoint for the GOV.UK Wallet to retrieve metadata about the credential issuer.

Responses

StatusDescriptionSchema
200

Credential issuer’s metadata.

{
  "credential_issuer": "https://example-credential-issuer.gov.uk",
  "authorization_servers": [
    "https://token.account.gov.uk"
  ],
  "credential_endpoint": "https://example-credential-issuer.gov.uk/credential",
  "notification_endpoint": "https://example-credential-issuer.gov.uk/notification",
  "credential_configurations_supported": {
    "fishingLicence": {
      "format": "jwt_vc_json",
      "credential_definition": {
        "type": [
          "VerifiableCredential",
          "FishingLicence"
        ]
      },
      "cryptographic_binding_methods_supported": [
        "did"
      ],
      "cryptographic_suites_supported": [
        "ES256K"
      ],
      "proof_types_supported": {
        "jwt": {
          "proof_signing_alg_values_supported": [
            "ES256"
          ],
          "key_attestations_required": null
        }
      },
      "display": [
        {
          "name": "Fishing Licence number",
          "locale": "en-GB",
          "background_color": "#12107c",
          "text_color": "#FFFFFF"
        },
        {
          "name": "Rhif Trwydded Pysgota",
          "locale": "en-CY",
          "background_color": "#12107c",
          "text_color": "#FFFFFF"
        }
      ],
      "credentialSubject": {
        "name": [
          {
            "nameParts": [
              {
                "display": [
                  {
                    "name": "Name",
                    "locale": "en-GB"
                  },
                  {
                    "name": "Enw",
                    "locale": "cy-GB"
                  }
                ]
              }
            ]
          }
        ],
        "fishingLicenceRecord": {
          "licenceNumber": {
            "display": [
              {
                "name": "Fishing Licence number",
                "locale": "en-GB"
              },
              {
                "name": "Rhif Trwydded Pysgota",
                "locale": "cy-GB"
              }
            ]
          },
          "expirationDate": {
            "display": [
              {
                "name": "Dyddiad dod i ben",
                "locale": "en-GB"
              },
              {
                "name": "Rhif Trwydded Pysgota",
                "locale": "cy-GB"
              }
            ]
          }
        }
      }
    }
  }
}
MetadataResponse

Schemas

MetadataResponse

NameTypeRequiredDescriptionSchema
credential_issuer string true

URL of the credential issuer.

credential_endpoint string true

URL of the credential issuer’s credential endpoint.

notification_endpoint string false

URL of the credential issuer’s notification endpoint.

authorization_servers array true

Set containing the URL of the authorization server(s) the credential issuer relies on for authorization.

credential_configurations_supported object true

Information about the credential(s) issued by the credential issuer.

CredentialConfigurationsSupported

CredentialConfigurationsSupported

Information about the credential(s) issued by the credential issuer.

NameTypeRequiredDescriptionSchema
fishingLicence object true

A credential issued by the credential issuer.

FishingLicence

FishingLicence

A credential issued by the credential issuer.

NameTypeRequiredDescriptionSchema
format string true

Format of the credential.

credential_definition object true

Description of the credential type.

CredentialDefinition
cryptographic_binding_methods_supported array true

Set of methods available for cryptographically binding the issued credential.

credential_signing_alg_values_supported array true

Set of algorithms that the credential issuer uses to sign the credential.

proof_types_supported object true

Key proof(s) supported by the credential issuer.

ProofTypesSupported
display array true

Display properties of the credential, such as the display name, logo, background colour, etc.

FishingLicenceDisplay
credentialSubject object true

Display properties of the subject of the credential.

CredentialSubject

CredentialDefinition

Description of the credential type.

NameTypeRequiredDescriptionSchema
type array true

ProofTypesSupported

Key proof(s) supported by the credential issuer.

NameTypeRequiredDescriptionSchema
jwt object true Jwt

Jwt

NameTypeRequiredDescriptionSchema
proof_signing_alg_values_supported array true
key_attestations_required object true

FishingLicenceDisplay

NameTypeRequiredDescriptionSchema
name string true
locale string true
background_color string true
text_color string true

CredentialSubject

Display properties of the subject of the credential.

NameTypeRequiredDescriptionSchema
name array true Name
fishingLicenceRecord object true FishingLicenceRecord

Name

NameTypeRequiredDescriptionSchema
nameParts array true NameParts

NameParts

NameTypeRequiredDescriptionSchema
display array true Display

Display

NameTypeRequiredDescriptionSchema
name string true
locale string true

FishingLicenceRecord

NameTypeRequiredDescriptionSchema
licenceNumber object true LicenceNumber
expirationDate object true ExpirationDate

LicenceNumber

NameTypeRequiredDescriptionSchema
display array true Display

ExpirationDate

NameTypeRequiredDescriptionSchema
display array true Display
This page was last reviewed on 21 March 2025. It needs to be reviewed again on 21 September 2025 .