Version 3.4

The version 3.4 adds an optional field owner in the request-credential message to request a credential issued to a particular DID

Version 3.3

The version 3.3 uses the proper name cTypeHash instead of cTypeId.

This specification was created anticipating a change in the SDK from cTypeHash to cTypeId, and this change has never arrived. The outcome was a specification which does not match the reality. While normally a change like this will be considered a breaking change, we’re rather fixing an error, that’s why it’s only a minor new version.

Version 3.2

The version 3.2 adds the reject-attestation message so that the attester dApp can signal to the extension that the attestation request was rejected.

Version 3.1

The version 3.1 adds an optional field in the submit-terms message. If the attester intends to issue the credential to a specific DID, they can indicate that by setting the owner property of the claim to this DID.

Version 3.0

The version 3.0 is the first non-draft version of the Credentials API specification.

It includes breaking changes in three messages: submit-terms, request-attestation, and submit-credential. You’d want to use the SDK version 0.29 or higher.

The dApp now also must announce the version of the specification it adheres to. This should help extensions with backwards compatibility. Here is one example of implementing it.

Version 2.0

The version 2.0 includes breaking changes in the names of data properties holding the URIs of DID keys: they are no longer called *Id. The claimer signature object format has also changed in the same fashion. As we anticipate more breaking changes coming in, we keep the "Draft" modifier.

You’d want to use the SDK version 0.28 or higher.

A hard compatibility check could refuse the communication when the value of specVersion does not match. Alternatively the backwards compatibility can be maintained by also including the properties named as in the previous version, and backfilling from them:

outgoingMessage.senderKeyId = outgoingMessage.senderKeyUri
incomingMessage.senderKeyUri = incomingMessage.senderKeyUri || incomingMessage.senderKeyId

Version 1.0

The text of this draft included a non-draft version value, and implementations already rely on specified names, so we are freezing this version as is.

Some breaking changes will be released as new versions, and then we will remove the "draft" modifier.

The data objects refer to the KILT SDK version 0.27 and below, the API documentation available here.