Skip to main content
Version: Next

CredentialMetadata

display object[]
  • Array [
  • namestring
    Example: Extended Display Name
    localestring
    Example: en-US
    logo object
    uristringrequired
    Example: https://example.com/image.png
    alt_textstring
    Example: Logo alt text
    descriptionstring
    Example: Extended display description
    background_colorstring
    Example: #ffffff
    background_image object
    uristringrequired
    Example: https://example.com/image.png
    text_colorstring
    Example: #000000
  • ]
  • claims object[]
  • Array [
  • path object[]required
  • Array [
  • oneOf
    string
  • ]
  • mandatoryboolean
    Example: true
    display object[]
  • Array [
  • namestring
    Example: Display Name
    localestring
    Example: en-US
  • ]
  • ]
  • CredentialMetadata
    {
    "display": [
    {
    "name": "University Degree",
    "locale": "en-US",
    "description": "A verified university degree credential",
    "background_color": "#ffffff",
    "text_color": "#000000",
    "logo": {
    "uri": "https://example.com/logo.png",
    "alt_text": "Logo alt text"
    }
    }
    ],
    "claims": [
    {
    "path": [
    "name"
    ],
    "mandatory": true,
    "display": [
    {
    "name": "Full Name",
    "locale": "en-US"
    }
    ]
    },
    {
    "path": [
    "degree"
    ],
    "mandatory": true,
    "display": [
    {
    "name": "Degree",
    "locale": "en-US"
    }
    ]
    },
    {
    "path": [
    "id"
    ],
    "mandatory": false,
    "display": [
    {
    "name": "Student ID",
    "locale": "en-US"
    }
    ]
    }
    ]
    }