Create a JSON credentials configuration

POST/v2/credentials/web-semantic/configurations

Creates a new JSON credentials configuration, a specific set of rules and parameters that are used to create and validate a particular type of verifiable credential. These rules and parameters define how the credential is structured and what data it contains when issued.

Roles

adminissuer

Analytics Events

CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_CREATE_STARTCREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_CREATE_SUCCESSCREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

The credential configuration payload

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/v2/credentials/web-semantic/configurations" \  -H "Content-Type: application/json" \  -d '{}'

{  "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  }}

Create a JSON credentials configuration

POST/v2/credentials/web-semantic/configurations

Roles

adminissuer

Analytics Events

CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_CREATE_STARTCREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_CREATE_SUCCESSCREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

The credential configuration payload

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Insert a meaningful name for the credential. This string is displayed on the top part of the credential in the holder's digital wallet. It is recommended to limit this value to 18 characters as any additional characters are not displayed on the credential.

Length1 <= length <= 1024

description?string

Insert a meaningful description for the credential. This string is displayed below the name field on the credential in the holder's digital wallet. It is recommended to limit this value to 38 characters as any additional characters are not displayed on the credential.

Lengthlength <= 1024

type*string

Used to differentiate between different JSON credentials configurations on your tenant. Thus, its value must:

Be unique across all JSON credentials configurations on your tenant.
Not be VerifiableCredential.

Length1 <= length <= 1024

additionalTypes?array<>

Additional credential types that can be referenced. Each entry must be 1-1024 characters long, with no whitespaces allowed.

contexts?array<>

Additional JSON-LD contexts to be included in the credential. As part of the credential issuance MATTR VII will auto-inject the following contexts, which reference the W3C Verifiable Credential definitions:

https://www.w3.org/2018/credentials/v1
https://mattr.global/contexts/vc-extensions/v2
https://w3id.org/vc-revocation-list-2020/v1 If you require introducing a different context for your production implementation, please contact us. Referenced contexts must be whitelisted or credential issuance will fail.

issuer*

Issuer details and branding for issued credentials. Refer to this video to learn more about branding best practices.

proofType?string

This is an optional field which defines the cryptographic algorithm used to sign the credential. The credential Issuer's DID must contain a key that supports the corresponding signing capability. If no proofType is provided, the credential will be signed using the key that is available in the Issuer's DID:

If a Bls12381G2 key is available, the credential will be signed with a BbsSignature2022 proof. Credentials signed with this proof type support selective disclosure.
If a Bls12381G2 key is unavailable and a Ed25519 key is available, the credential will be signed with a Ed25519Signature2018 proof. Credentials signed with this proof type do not support selective disclosure.
If none of the two suitable keys are available, the request will be rejected and the credential will not be created.

Value in

"Ed25519Signature2018"
"BbsSignature2022"

credentialBranding?

Additional branding that will be applied to issued credentials. Refer to this video to learn more about branding best practices.

claimMappings?

This is where you specify how to map claims (user attributes) into issued credentials. Each field in the object corresponds to a claim in the issued credential, and contains one or more from the following attributes:

mapFrom: References the path in the user object where the claim is available.
- When using a URL as a claims namespace identifier, use bracket notation to access the claim value (e.g. mapFrom: "claims['https://example.com/claim-name']").
- mapFrom is optional when defaultValue is provided, as the latter will be used for all issued credentials. This is referred to as a static claim.
defaultValue: Indicates what value is used if required is set to false (field is optional) and no value is provided by the claims source. When defaultValue is provided, mapFrom is optional.
required: Indicates whether the claim is required (default: false). When a required claim cannot be retrieved and no defaultValue is available, credential issuance will fail. Example claims object inside the user object

{  "claims": {    "given_name": "Jamie",    "family_name": "Doe",    "address": {      "formatted": "116-118 Quay Street, Auckland CBD, Auckland 1010"    }  },  "authenticationProvider": {    "subjectId": "6d3aab7d-73af-5f61-b47c-109ef6f7558c",    "url": "https://accounts.google.com"  }}

persist?boolean

When set to true, both the issued credential and its metadata are stored in the credential registry. When set to false (default) only the following metadata is stored:

id
tag
credentialStatus
issuanceDate

Defaultfalse

revocable?boolean

When set to true (default), the created credential can later be revoked. When set to false, the credential cannot be revoked. When set to true, https://w3id.org/vc-revocation-list-2020/v1 is injected into the credential @context object when it is issued. This references the JSON-LD definition of the credentialStatus object used to manage revocation status.

Defaulttrue

claimSourceId?string

References the unique identifier of a claims source that can be used to retrieve claims and include them in the issued credential.

Formatuuid

expiresIn?

Used to determine when will issued credentials expire. Can include any combination of years, months, weeks, days, hours, minutes and seconds.

Response Body

`application/json`

curl -X POST "https://example.com/v2/credentials/web-semantic/configurations" \  -H "Content-Type: application/json" \  -d '{}'

{  "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  }}

How would you rate this page?

{ "claims": { "given_name": "Jamie", "family_name": "Doe", "address": { "formatted": "116-118 Quay Street, Auckland CBD, Auckland 1010" } }, "authenticationProvider": { "subjectId": "6d3aab7d-73af-5f61-b47c-109ef6f7558c", "url": "https://accounts.google.com" }}

Create a JSON credentials configuration

Roles

Analytics Events

Authorization

Request Body

Response Body

201application/json

400application/json

Create a JSON credentials configuration

Roles

Analytics Events

Authorization

Request Body

Response Body

201application/json

400application/json

`application/json`

`application/json`

`application/json`

`application/json`