Retrieve a JSON credentials configuration

Retrieve a JSON credentials configuration by providing its ID.

Analytics Events

CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_STARTCREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_SUCCESSCREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_FAIL

Roles

adminissuer

GET/v2/credentials/web-semantic/configurations/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

idstring

JSON credentials configuration unique identifier

Formatuuid

Response Body

curl -X GET "https://example.vii.au01.mattr.global/v2/credentials/web-semantic/configurations/3948c40e-6e19-4ffc-933c-91f643f24264"

curl -X GET "https://example.vii.au01.mattr.global/v2/credentials/web-semantic/configurations/3948c40e-6e19-4ffc-933c-91f643f24264"

{
  "id": "983c0a86-204f-4431-9371-f5a22e506599",
  "name": "Course credential",
  "description": "This credential shows that the person has attended a course.",
  "type": "CourseCredential",
  "additionalTypes": [
    "AlumniCredential",
    "EducationCredential"
  ],
  "contexts": [
    "https://optionalschema.example/"
  ],
  "issuer": {
    "name": "ABC University",
    "logoUrl": "https://example.edu/img/logo.png",
    "iconUrl": "https://example.edu/img/icon.png"
  },
  "proofType": "Ed25519Signature2018",
  "credentialBranding": {
    "backgroundColor": "#B00AA0",
    "watermarkImageUrl": "https://example.edu/img/watermark.png"
  },
  "claimMappings": {
    "firstName": {
      "mapFrom": "claims.given_name",
      "required": true
    },
    "address": {
      "mapFrom": "claims.address.formatted"
    },
    "picture": {
      "mapFrom": "claims.picture",
      "defaultValue": "http://example.edu/img/placeholder.png"
    },
    "badge": {
      "defaultValue": "http://example.edu/img/badge.png"
    },
    "providerSubjectId": {
      "mapFrom": "authenticationProvider.subjectId"
    }
  },
  "persist": false,
  "revocable": true,
  "claimSourceId": "78e1b90c-401d-45bb-89c0-938da4d44c60",
  "expiresIn": {
    "years": 0,
    "months": 3,
    "weeks": 0,
    "days": 0,
    "hours": 0,
    "minutes": 0,
    "seconds": 0
  }
}

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}