@twin.org/standards-w3c-did 0.0.3-next.55 → 0.0.3-next.56
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/changelog.md +14 -0
- package/docs/reference/interfaces/IDataIntegrityProof.md +10 -10
- package/docs/reference/interfaces/IDidCredentialStatus.md +1 -1
- package/docs/reference/interfaces/IDidDocument.md +9 -9
- package/docs/reference/interfaces/IDidDocumentVerificationMethod.md +3 -3
- package/docs/reference/interfaces/IDidLabel.md +1 -1
- package/docs/reference/interfaces/IDidPresentationVerification.md +2 -2
- package/docs/reference/interfaces/IDidVerifiableCredentialCommon.md +9 -9
- package/docs/reference/interfaces/IDidVerifiableCredentialV1.md +11 -11
- package/docs/reference/interfaces/IDidVerifiableCredentialV2.md +11 -11
- package/docs/reference/interfaces/IDidVerifiablePresentationCommon.md +3 -3
- package/docs/reference/interfaces/IDidVerifiablePresentationV1.md +4 -4
- package/docs/reference/interfaces/IDidVerifiablePresentationV2.md +4 -4
- package/docs/reference/interfaces/IJsonWebSignature2020Proof.md +4 -4
- package/docs/reference/interfaces/IMultikey.md +6 -6
- package/package.json +1 -1
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.3-next.56](https://github.com/twinfoundation/standards/compare/standards-w3c-did-v0.0.3-next.55...standards-w3c-did-v0.0.3-next.56) (2026-03-20)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Miscellaneous Chores
|
|
7
|
+
|
|
8
|
+
* **standards-w3c-did:** Synchronize repo versions
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Dependencies
|
|
12
|
+
|
|
13
|
+
* The following workspace dependencies were updated
|
|
14
|
+
* devDependencies
|
|
15
|
+
* @twin.org/standards-ld-contexts bumped from 0.0.3-next.55 to 0.0.3-next.56
|
|
16
|
+
|
|
3
17
|
## [0.0.3-next.55](https://github.com/twinfoundation/standards/compare/standards-w3c-did-v0.0.3-next.54...standards-w3c-did-v0.0.3-next.55) (2026-03-19)
|
|
4
18
|
|
|
5
19
|
|
|
@@ -7,7 +7,7 @@ https://www.w3.org/TR/vc-data-integrity/
|
|
|
7
7
|
|
|
8
8
|
### @context? {#context}
|
|
9
9
|
|
|
10
|
-
> `optional` **@context
|
|
10
|
+
> `optional` **@context?**: `"https://w3id.org/security/data-integrity/v2"` \| `SingleOccurrenceArray`\<`IJsonLdContextDefinitionElement`, `"https://w3id.org/security/data-integrity/v2"`\>
|
|
11
11
|
|
|
12
12
|
JSON-LD Context.
|
|
13
13
|
|
|
@@ -31,7 +31,7 @@ An identifier for the cryptographic suite that can be used to verify the proof.
|
|
|
31
31
|
|
|
32
32
|
### id? {#id}
|
|
33
33
|
|
|
34
|
-
> `optional` **id
|
|
34
|
+
> `optional` **id?**: `string`
|
|
35
35
|
|
|
36
36
|
The id of the proof.
|
|
37
37
|
|
|
@@ -47,7 +47,7 @@ The reason the proof was created.
|
|
|
47
47
|
|
|
48
48
|
### proofValue? {#proofvalue}
|
|
49
49
|
|
|
50
|
-
> `optional` **proofValue
|
|
50
|
+
> `optional` **proofValue?**: `string`
|
|
51
51
|
|
|
52
52
|
Contains the base-encoded binary data necessary to verify the
|
|
53
53
|
digital proof using the verificationMethod specified.
|
|
@@ -56,7 +56,7 @@ digital proof using the verificationMethod specified.
|
|
|
56
56
|
|
|
57
57
|
### verificationMethod? {#verificationmethod}
|
|
58
58
|
|
|
59
|
-
> `optional` **verificationMethod
|
|
59
|
+
> `optional` **verificationMethod?**: `string`
|
|
60
60
|
|
|
61
61
|
The verification method of the proof.
|
|
62
62
|
|
|
@@ -64,7 +64,7 @@ The verification method of the proof.
|
|
|
64
64
|
|
|
65
65
|
### created? {#created}
|
|
66
66
|
|
|
67
|
-
> `optional` **created
|
|
67
|
+
> `optional` **created?**: `string`
|
|
68
68
|
|
|
69
69
|
The iso date of when the proof was created.
|
|
70
70
|
|
|
@@ -72,7 +72,7 @@ The iso date of when the proof was created.
|
|
|
72
72
|
|
|
73
73
|
### expires? {#expires}
|
|
74
74
|
|
|
75
|
-
> `optional` **expires
|
|
75
|
+
> `optional` **expires?**: `string`
|
|
76
76
|
|
|
77
77
|
The iso date of when the proof expires.
|
|
78
78
|
|
|
@@ -80,7 +80,7 @@ The iso date of when the proof expires.
|
|
|
80
80
|
|
|
81
81
|
### domain? {#domain}
|
|
82
82
|
|
|
83
|
-
> `optional` **domain
|
|
83
|
+
> `optional` **domain?**: `ObjectOrArray`\<`string`\>
|
|
84
84
|
|
|
85
85
|
One or more security domains in which the proof is meant to be used.
|
|
86
86
|
|
|
@@ -88,7 +88,7 @@ One or more security domains in which the proof is meant to be used.
|
|
|
88
88
|
|
|
89
89
|
### challenge? {#challenge}
|
|
90
90
|
|
|
91
|
-
> `optional` **challenge
|
|
91
|
+
> `optional` **challenge?**: `ObjectOrArray`\<`string`\>
|
|
92
92
|
|
|
93
93
|
Provided to mitigate replay attacks on domains.
|
|
94
94
|
|
|
@@ -96,7 +96,7 @@ Provided to mitigate replay attacks on domains.
|
|
|
96
96
|
|
|
97
97
|
### previousProof? {#previousproof}
|
|
98
98
|
|
|
99
|
-
> `optional` **previousProof
|
|
99
|
+
> `optional` **previousProof?**: `string`
|
|
100
100
|
|
|
101
101
|
Identifies another data integrity proof that MUST verify before
|
|
102
102
|
the current proof is processed
|
|
@@ -105,7 +105,7 @@ the current proof is processed
|
|
|
105
105
|
|
|
106
106
|
### nonce? {#nonce}
|
|
107
107
|
|
|
108
|
-
> `optional` **nonce
|
|
108
|
+
> `optional` **nonce?**: `string`
|
|
109
109
|
|
|
110
110
|
Use of this field is to increase privacy by decreasing linkability
|
|
111
111
|
that is the result of deterministically generated signatures.
|
|
@@ -23,7 +23,7 @@ The id for the document.
|
|
|
23
23
|
|
|
24
24
|
### alsoKnownAs? {#alsoknownas}
|
|
25
25
|
|
|
26
|
-
> `optional` **alsoKnownAs
|
|
26
|
+
> `optional` **alsoKnownAs?**: `ObjectOrArray`\<`string`\>
|
|
27
27
|
|
|
28
28
|
Aliases for the document.
|
|
29
29
|
|
|
@@ -31,7 +31,7 @@ Aliases for the document.
|
|
|
31
31
|
|
|
32
32
|
### controller? {#controller}
|
|
33
33
|
|
|
34
|
-
> `optional` **controller
|
|
34
|
+
> `optional` **controller?**: `ObjectOrArray`\<`string`\>
|
|
35
35
|
|
|
36
36
|
The controller for the document.
|
|
37
37
|
|
|
@@ -39,7 +39,7 @@ The controller for the document.
|
|
|
39
39
|
|
|
40
40
|
### verificationMethod? {#verificationmethod}
|
|
41
41
|
|
|
42
|
-
> `optional` **verificationMethod
|
|
42
|
+
> `optional` **verificationMethod?**: (`string` \| [`IDidDocumentVerificationMethod`](IDidDocumentVerificationMethod.md))[]
|
|
43
43
|
|
|
44
44
|
The verification methods.
|
|
45
45
|
|
|
@@ -47,7 +47,7 @@ The verification methods.
|
|
|
47
47
|
|
|
48
48
|
### authentication? {#authentication}
|
|
49
49
|
|
|
50
|
-
> `optional` **authentication
|
|
50
|
+
> `optional` **authentication?**: (`string` \| [`IDidDocumentVerificationMethod`](IDidDocumentVerificationMethod.md))[]
|
|
51
51
|
|
|
52
52
|
The authentication methods.
|
|
53
53
|
|
|
@@ -55,7 +55,7 @@ The authentication methods.
|
|
|
55
55
|
|
|
56
56
|
### assertionMethod? {#assertionmethod}
|
|
57
57
|
|
|
58
|
-
> `optional` **assertionMethod
|
|
58
|
+
> `optional` **assertionMethod?**: (`string` \| [`IDidDocumentVerificationMethod`](IDidDocumentVerificationMethod.md))[]
|
|
59
59
|
|
|
60
60
|
The assertion methods.
|
|
61
61
|
|
|
@@ -63,7 +63,7 @@ The assertion methods.
|
|
|
63
63
|
|
|
64
64
|
### keyAgreement? {#keyagreement}
|
|
65
65
|
|
|
66
|
-
> `optional` **keyAgreement
|
|
66
|
+
> `optional` **keyAgreement?**: (`string` \| [`IDidDocumentVerificationMethod`](IDidDocumentVerificationMethod.md))[]
|
|
67
67
|
|
|
68
68
|
The key agreements.
|
|
69
69
|
|
|
@@ -71,7 +71,7 @@ The key agreements.
|
|
|
71
71
|
|
|
72
72
|
### capabilityInvocation? {#capabilityinvocation}
|
|
73
73
|
|
|
74
|
-
> `optional` **capabilityInvocation
|
|
74
|
+
> `optional` **capabilityInvocation?**: (`string` \| [`IDidDocumentVerificationMethod`](IDidDocumentVerificationMethod.md))[]
|
|
75
75
|
|
|
76
76
|
The capability invocations.
|
|
77
77
|
|
|
@@ -79,7 +79,7 @@ The capability invocations.
|
|
|
79
79
|
|
|
80
80
|
### capabilityDelegation? {#capabilitydelegation}
|
|
81
81
|
|
|
82
|
-
> `optional` **capabilityDelegation
|
|
82
|
+
> `optional` **capabilityDelegation?**: (`string` \| [`IDidDocumentVerificationMethod`](IDidDocumentVerificationMethod.md))[]
|
|
83
83
|
|
|
84
84
|
The capability delegations.
|
|
85
85
|
|
|
@@ -87,6 +87,6 @@ The capability delegations.
|
|
|
87
87
|
|
|
88
88
|
### service? {#service}
|
|
89
89
|
|
|
90
|
-
> `optional` **service
|
|
90
|
+
> `optional` **service?**: [`IDidService`](IDidService.md)[]
|
|
91
91
|
|
|
92
92
|
The services.
|
|
@@ -30,7 +30,7 @@ The type of the entry.
|
|
|
30
30
|
|
|
31
31
|
### publicKeyMultibase? {#publickeymultibase}
|
|
32
32
|
|
|
33
|
-
> `optional` **publicKeyMultibase
|
|
33
|
+
> `optional` **publicKeyMultibase?**: `string`
|
|
34
34
|
|
|
35
35
|
The public key for the entry.
|
|
36
36
|
Spec https://datatracker.ietf.org/doc/html/draft-multiformats-multibase-03 .
|
|
@@ -39,7 +39,7 @@ Spec https://datatracker.ietf.org/doc/html/draft-multiformats-multibase-03 .
|
|
|
39
39
|
|
|
40
40
|
### publicKeyJwk? {#publickeyjwk}
|
|
41
41
|
|
|
42
|
-
> `optional` **publicKeyJwk
|
|
42
|
+
> `optional` **publicKeyJwk?**: `JWK` & `IJsonLdNodeObject`
|
|
43
43
|
|
|
44
44
|
The public key for the entry as a JWK.
|
|
45
45
|
Spec https://datatracker.ietf.org/doc/html/rfc7517 .
|
|
@@ -48,6 +48,6 @@ Spec https://datatracker.ietf.org/doc/html/rfc7517 .
|
|
|
48
48
|
|
|
49
49
|
### revocation? {#revocation}
|
|
50
50
|
|
|
51
|
-
> `optional` **revocation
|
|
51
|
+
> `optional` **revocation?**: `string`
|
|
52
52
|
|
|
53
53
|
Multi key partial revocation.
|
|
@@ -14,7 +14,7 @@ Is the whole presentation verified.
|
|
|
14
14
|
|
|
15
15
|
### holder? {#holder}
|
|
16
16
|
|
|
17
|
-
> `optional` **holder
|
|
17
|
+
> `optional` **holder?**: `object`
|
|
18
18
|
|
|
19
19
|
Who was the holder.
|
|
20
20
|
|
|
@@ -32,6 +32,6 @@ Is the holder verified.
|
|
|
32
32
|
|
|
33
33
|
#### document?
|
|
34
34
|
|
|
35
|
-
> `optional` **document
|
|
35
|
+
> `optional` **document?**: [`IDidDocument`](IDidDocument.md)
|
|
36
36
|
|
|
37
37
|
The DID document for the holder.
|
|
@@ -12,7 +12,7 @@ https://www.w3.org/TR/vc-data-model-2.0
|
|
|
12
12
|
|
|
13
13
|
### id? {#id}
|
|
14
14
|
|
|
15
|
-
> `optional` **id
|
|
15
|
+
> `optional` **id?**: `string`
|
|
16
16
|
|
|
17
17
|
The identifier for the verifiable credential.
|
|
18
18
|
|
|
@@ -28,7 +28,7 @@ The types of the data stored in the verifiable credential.
|
|
|
28
28
|
|
|
29
29
|
### credentialSubject? {#credentialsubject}
|
|
30
30
|
|
|
31
|
-
> `optional` **credentialSubject
|
|
31
|
+
> `optional` **credentialSubject?**: `ObjectOrArray`\<`IJsonLdNodeObject`\>
|
|
32
32
|
|
|
33
33
|
The data for the verifiable credential.
|
|
34
34
|
|
|
@@ -36,7 +36,7 @@ The data for the verifiable credential.
|
|
|
36
36
|
|
|
37
37
|
### credentialStatus? {#credentialstatus}
|
|
38
38
|
|
|
39
|
-
> `optional` **credentialStatus
|
|
39
|
+
> `optional` **credentialStatus?**: `ObjectOrArray`\<[`IDidCredentialStatus`](IDidCredentialStatus.md)\>
|
|
40
40
|
|
|
41
41
|
Used to discover information about the current status of the
|
|
42
42
|
verifiable credential, such as whether it is suspended or revoked.
|
|
@@ -45,7 +45,7 @@ verifiable credential, such as whether it is suspended or revoked.
|
|
|
45
45
|
|
|
46
46
|
### credentialSchema? {#credentialschema}
|
|
47
47
|
|
|
48
|
-
> `optional` **credentialSchema
|
|
48
|
+
> `optional` **credentialSchema?**: `ObjectOrArray`\<[`IDidCredentialSchema`](IDidCredentialSchema.md)\>
|
|
49
49
|
|
|
50
50
|
Annotate type definitions or lock them to specific versions of the vocabulary.
|
|
51
51
|
|
|
@@ -53,7 +53,7 @@ Annotate type definitions or lock them to specific versions of the vocabulary.
|
|
|
53
53
|
|
|
54
54
|
### issuer? {#issuer}
|
|
55
55
|
|
|
56
|
-
> `optional` **issuer
|
|
56
|
+
> `optional` **issuer?**: `string` \| \{ `id`: `string`; `name?`: `string` \| [`IDidLabel`](IDidLabel.md)[]; `description?`: `string` \| [`IDidLabel`](IDidLabel.md)[]; \}
|
|
57
57
|
|
|
58
58
|
The issuing identity.
|
|
59
59
|
|
|
@@ -61,7 +61,7 @@ The issuing identity.
|
|
|
61
61
|
|
|
62
62
|
### name? {#name}
|
|
63
63
|
|
|
64
|
-
> `optional` **name
|
|
64
|
+
> `optional` **name?**: `string` \| [`IDidLabel`](IDidLabel.md)[]
|
|
65
65
|
|
|
66
66
|
The name of the credential.
|
|
67
67
|
|
|
@@ -69,7 +69,7 @@ The name of the credential.
|
|
|
69
69
|
|
|
70
70
|
### description? {#description}
|
|
71
71
|
|
|
72
|
-
> `optional` **description
|
|
72
|
+
> `optional` **description?**: `string` \| [`IDidLabel`](IDidLabel.md)[]
|
|
73
73
|
|
|
74
74
|
The description of the credential.
|
|
75
75
|
|
|
@@ -77,7 +77,7 @@ The description of the credential.
|
|
|
77
77
|
|
|
78
78
|
### evidence? {#evidence}
|
|
79
79
|
|
|
80
|
-
> `optional` **evidence
|
|
80
|
+
> `optional` **evidence?**: `ObjectOrArray`\<`IJsonLdNodeObject`\>
|
|
81
81
|
|
|
82
82
|
Evidence associated with the Credential.
|
|
83
83
|
|
|
@@ -85,7 +85,7 @@ Evidence associated with the Credential.
|
|
|
85
85
|
|
|
86
86
|
### proof? {#proof}
|
|
87
87
|
|
|
88
|
-
> `optional` **proof
|
|
88
|
+
> `optional` **proof?**: `ObjectOrArray`\<[`IProof`](../type-aliases/IProof.md)\>
|
|
89
89
|
|
|
90
90
|
Proofs that the verifiable credential is valid.
|
|
91
91
|
Optional if a different proof method is used, such as JWT.
|
|
@@ -11,7 +11,7 @@ https://www.w3.org/TR/vc-data-model-1.1
|
|
|
11
11
|
|
|
12
12
|
### id? {#id}
|
|
13
13
|
|
|
14
|
-
> `optional` **id
|
|
14
|
+
> `optional` **id?**: `string`
|
|
15
15
|
|
|
16
16
|
The identifier for the verifiable credential.
|
|
17
17
|
|
|
@@ -35,7 +35,7 @@ The types of the data stored in the verifiable credential.
|
|
|
35
35
|
|
|
36
36
|
### credentialSubject? {#credentialsubject}
|
|
37
37
|
|
|
38
|
-
> `optional` **credentialSubject
|
|
38
|
+
> `optional` **credentialSubject?**: `ObjectOrArray`\<`IJsonLdNodeObject`\>
|
|
39
39
|
|
|
40
40
|
The data for the verifiable credential.
|
|
41
41
|
|
|
@@ -47,7 +47,7 @@ The data for the verifiable credential.
|
|
|
47
47
|
|
|
48
48
|
### credentialStatus? {#credentialstatus}
|
|
49
49
|
|
|
50
|
-
> `optional` **credentialStatus
|
|
50
|
+
> `optional` **credentialStatus?**: `ObjectOrArray`\<[`IDidCredentialStatus`](IDidCredentialStatus.md)\>
|
|
51
51
|
|
|
52
52
|
Used to discover information about the current status of the
|
|
53
53
|
verifiable credential, such as whether it is suspended or revoked.
|
|
@@ -60,7 +60,7 @@ verifiable credential, such as whether it is suspended or revoked.
|
|
|
60
60
|
|
|
61
61
|
### credentialSchema? {#credentialschema}
|
|
62
62
|
|
|
63
|
-
> `optional` **credentialSchema
|
|
63
|
+
> `optional` **credentialSchema?**: `ObjectOrArray`\<[`IDidCredentialSchema`](IDidCredentialSchema.md)\>
|
|
64
64
|
|
|
65
65
|
Annotate type definitions or lock them to specific versions of the vocabulary.
|
|
66
66
|
|
|
@@ -72,7 +72,7 @@ Annotate type definitions or lock them to specific versions of the vocabulary.
|
|
|
72
72
|
|
|
73
73
|
### issuer? {#issuer}
|
|
74
74
|
|
|
75
|
-
> `optional` **issuer
|
|
75
|
+
> `optional` **issuer?**: `string` \| \{ `id`: `string`; `name?`: `string` \| [`IDidLabel`](IDidLabel.md)[]; `description?`: `string` \| [`IDidLabel`](IDidLabel.md)[]; \}
|
|
76
76
|
|
|
77
77
|
The issuing identity.
|
|
78
78
|
|
|
@@ -84,7 +84,7 @@ The issuing identity.
|
|
|
84
84
|
|
|
85
85
|
### name? {#name}
|
|
86
86
|
|
|
87
|
-
> `optional` **name
|
|
87
|
+
> `optional` **name?**: `string` \| [`IDidLabel`](IDidLabel.md)[]
|
|
88
88
|
|
|
89
89
|
The name of the credential.
|
|
90
90
|
|
|
@@ -96,7 +96,7 @@ The name of the credential.
|
|
|
96
96
|
|
|
97
97
|
### description? {#description}
|
|
98
98
|
|
|
99
|
-
> `optional` **description
|
|
99
|
+
> `optional` **description?**: `string` \| [`IDidLabel`](IDidLabel.md)[]
|
|
100
100
|
|
|
101
101
|
The description of the credential.
|
|
102
102
|
|
|
@@ -108,7 +108,7 @@ The description of the credential.
|
|
|
108
108
|
|
|
109
109
|
### evidence? {#evidence}
|
|
110
110
|
|
|
111
|
-
> `optional` **evidence
|
|
111
|
+
> `optional` **evidence?**: `ObjectOrArray`\<`IJsonLdNodeObject`\>
|
|
112
112
|
|
|
113
113
|
Evidence associated with the Credential.
|
|
114
114
|
|
|
@@ -120,7 +120,7 @@ Evidence associated with the Credential.
|
|
|
120
120
|
|
|
121
121
|
### proof? {#proof}
|
|
122
122
|
|
|
123
|
-
> `optional` **proof
|
|
123
|
+
> `optional` **proof?**: `ObjectOrArray`\<[`IProof`](../type-aliases/IProof.md)\>
|
|
124
124
|
|
|
125
125
|
Proofs that the verifiable credential is valid.
|
|
126
126
|
Optional if a different proof method is used, such as JWT.
|
|
@@ -141,7 +141,7 @@ The context for the verifiable credential.
|
|
|
141
141
|
|
|
142
142
|
### issuanceDate? {#issuancedate}
|
|
143
143
|
|
|
144
|
-
> `optional` **issuanceDate
|
|
144
|
+
> `optional` **issuanceDate?**: `string`
|
|
145
145
|
|
|
146
146
|
The date the verifiable credential was issued, depending on version validFrom might be set instead.
|
|
147
147
|
|
|
@@ -149,6 +149,6 @@ The date the verifiable credential was issued, depending on version validFrom mi
|
|
|
149
149
|
|
|
150
150
|
### expirationDate? {#expirationdate}
|
|
151
151
|
|
|
152
|
-
> `optional` **expirationDate
|
|
152
|
+
> `optional` **expirationDate?**: `string`
|
|
153
153
|
|
|
154
154
|
The date the verifiable credential expires, depending on version validUntil might be set instead.
|
|
@@ -11,7 +11,7 @@ https://www.w3.org/TR/vc-data-model-2.0
|
|
|
11
11
|
|
|
12
12
|
### id? {#id}
|
|
13
13
|
|
|
14
|
-
> `optional` **id
|
|
14
|
+
> `optional` **id?**: `string`
|
|
15
15
|
|
|
16
16
|
The identifier for the verifiable credential.
|
|
17
17
|
|
|
@@ -35,7 +35,7 @@ The types of the data stored in the verifiable credential.
|
|
|
35
35
|
|
|
36
36
|
### credentialSubject? {#credentialsubject}
|
|
37
37
|
|
|
38
|
-
> `optional` **credentialSubject
|
|
38
|
+
> `optional` **credentialSubject?**: `ObjectOrArray`\<`IJsonLdNodeObject`\>
|
|
39
39
|
|
|
40
40
|
The data for the verifiable credential.
|
|
41
41
|
|
|
@@ -47,7 +47,7 @@ The data for the verifiable credential.
|
|
|
47
47
|
|
|
48
48
|
### credentialStatus? {#credentialstatus}
|
|
49
49
|
|
|
50
|
-
> `optional` **credentialStatus
|
|
50
|
+
> `optional` **credentialStatus?**: `ObjectOrArray`\<[`IDidCredentialStatus`](IDidCredentialStatus.md)\>
|
|
51
51
|
|
|
52
52
|
Used to discover information about the current status of the
|
|
53
53
|
verifiable credential, such as whether it is suspended or revoked.
|
|
@@ -60,7 +60,7 @@ verifiable credential, such as whether it is suspended or revoked.
|
|
|
60
60
|
|
|
61
61
|
### credentialSchema? {#credentialschema}
|
|
62
62
|
|
|
63
|
-
> `optional` **credentialSchema
|
|
63
|
+
> `optional` **credentialSchema?**: `ObjectOrArray`\<[`IDidCredentialSchema`](IDidCredentialSchema.md)\>
|
|
64
64
|
|
|
65
65
|
Annotate type definitions or lock them to specific versions of the vocabulary.
|
|
66
66
|
|
|
@@ -72,7 +72,7 @@ Annotate type definitions or lock them to specific versions of the vocabulary.
|
|
|
72
72
|
|
|
73
73
|
### issuer? {#issuer}
|
|
74
74
|
|
|
75
|
-
> `optional` **issuer
|
|
75
|
+
> `optional` **issuer?**: `string` \| \{ `id`: `string`; `name?`: `string` \| [`IDidLabel`](IDidLabel.md)[]; `description?`: `string` \| [`IDidLabel`](IDidLabel.md)[]; \}
|
|
76
76
|
|
|
77
77
|
The issuing identity.
|
|
78
78
|
|
|
@@ -84,7 +84,7 @@ The issuing identity.
|
|
|
84
84
|
|
|
85
85
|
### name? {#name}
|
|
86
86
|
|
|
87
|
-
> `optional` **name
|
|
87
|
+
> `optional` **name?**: `string` \| [`IDidLabel`](IDidLabel.md)[]
|
|
88
88
|
|
|
89
89
|
The name of the credential.
|
|
90
90
|
|
|
@@ -96,7 +96,7 @@ The name of the credential.
|
|
|
96
96
|
|
|
97
97
|
### description? {#description}
|
|
98
98
|
|
|
99
|
-
> `optional` **description
|
|
99
|
+
> `optional` **description?**: `string` \| [`IDidLabel`](IDidLabel.md)[]
|
|
100
100
|
|
|
101
101
|
The description of the credential.
|
|
102
102
|
|
|
@@ -108,7 +108,7 @@ The description of the credential.
|
|
|
108
108
|
|
|
109
109
|
### evidence? {#evidence}
|
|
110
110
|
|
|
111
|
-
> `optional` **evidence
|
|
111
|
+
> `optional` **evidence?**: `ObjectOrArray`\<`IJsonLdNodeObject`\>
|
|
112
112
|
|
|
113
113
|
Evidence associated with the Credential.
|
|
114
114
|
|
|
@@ -120,7 +120,7 @@ Evidence associated with the Credential.
|
|
|
120
120
|
|
|
121
121
|
### proof? {#proof}
|
|
122
122
|
|
|
123
|
-
> `optional` **proof
|
|
123
|
+
> `optional` **proof?**: `ObjectOrArray`\<[`IProof`](../type-aliases/IProof.md)\>
|
|
124
124
|
|
|
125
125
|
Proofs that the verifiable credential is valid.
|
|
126
126
|
Optional if a different proof method is used, such as JWT.
|
|
@@ -141,7 +141,7 @@ The context for the verifiable credential.
|
|
|
141
141
|
|
|
142
142
|
### validFrom? {#validfrom}
|
|
143
143
|
|
|
144
|
-
> `optional` **validFrom
|
|
144
|
+
> `optional` **validFrom?**: `string`
|
|
145
145
|
|
|
146
146
|
The date the verifiable credential is valid from.
|
|
147
147
|
|
|
@@ -149,6 +149,6 @@ The date the verifiable credential is valid from.
|
|
|
149
149
|
|
|
150
150
|
### validUntil? {#validuntil}
|
|
151
151
|
|
|
152
|
-
> `optional` **validUntil
|
|
152
|
+
> `optional` **validUntil?**: `string`
|
|
153
153
|
|
|
154
154
|
The date the verifiable credential is valid until.
|
|
@@ -11,7 +11,7 @@ Interface describing a verifiable presentation.
|
|
|
11
11
|
|
|
12
12
|
### id? {#id}
|
|
13
13
|
|
|
14
|
-
> `optional` **id
|
|
14
|
+
> `optional` **id?**: `string`
|
|
15
15
|
|
|
16
16
|
Provide a unique identifier for the presentation.
|
|
17
17
|
|
|
@@ -27,7 +27,7 @@ The types of the data stored in the verifiable credential.
|
|
|
27
27
|
|
|
28
28
|
### holder? {#holder}
|
|
29
29
|
|
|
30
|
-
> `optional` **holder
|
|
30
|
+
> `optional` **holder?**: `string`
|
|
31
31
|
|
|
32
32
|
The entity generating the presentation.
|
|
33
33
|
|
|
@@ -35,7 +35,7 @@ The entity generating the presentation.
|
|
|
35
35
|
|
|
36
36
|
### proof? {#proof}
|
|
37
37
|
|
|
38
|
-
> `optional` **proof
|
|
38
|
+
> `optional` **proof?**: `ObjectOrArray`\<[`IProof`](../type-aliases/IProof.md)\>
|
|
39
39
|
|
|
40
40
|
Proofs that the verifiable presentation is valid.
|
|
41
41
|
Optional if a different proof method is used, such as JWT.
|
|
@@ -10,7 +10,7 @@ Interface describing a verifiable presentation.
|
|
|
10
10
|
|
|
11
11
|
### id? {#id}
|
|
12
12
|
|
|
13
|
-
> `optional` **id
|
|
13
|
+
> `optional` **id?**: `string`
|
|
14
14
|
|
|
15
15
|
Provide a unique identifier for the presentation.
|
|
16
16
|
|
|
@@ -34,7 +34,7 @@ The types of the data stored in the verifiable credential.
|
|
|
34
34
|
|
|
35
35
|
### holder? {#holder}
|
|
36
36
|
|
|
37
|
-
> `optional` **holder
|
|
37
|
+
> `optional` **holder?**: `string`
|
|
38
38
|
|
|
39
39
|
The entity generating the presentation.
|
|
40
40
|
|
|
@@ -46,7 +46,7 @@ The entity generating the presentation.
|
|
|
46
46
|
|
|
47
47
|
### proof? {#proof}
|
|
48
48
|
|
|
49
|
-
> `optional` **proof
|
|
49
|
+
> `optional` **proof?**: `ObjectOrArray`\<[`IProof`](../type-aliases/IProof.md)\>
|
|
50
50
|
|
|
51
51
|
Proofs that the verifiable presentation is valid.
|
|
52
52
|
Optional if a different proof method is used, such as JWT.
|
|
@@ -67,6 +67,6 @@ The context for the verifiable presentation.
|
|
|
67
67
|
|
|
68
68
|
### verifiableCredential? {#verifiablecredential}
|
|
69
69
|
|
|
70
|
-
> `optional` **verifiableCredential
|
|
70
|
+
> `optional` **verifiableCredential?**: (`string` \| [`IDidVerifiableCredentialV1`](IDidVerifiableCredentialV1.md))[]
|
|
71
71
|
|
|
72
72
|
The data for the verifiable credentials.
|
|
@@ -10,7 +10,7 @@ Interface describing a verifiable presentation.
|
|
|
10
10
|
|
|
11
11
|
### id? {#id}
|
|
12
12
|
|
|
13
|
-
> `optional` **id
|
|
13
|
+
> `optional` **id?**: `string`
|
|
14
14
|
|
|
15
15
|
Provide a unique identifier for the presentation.
|
|
16
16
|
|
|
@@ -34,7 +34,7 @@ The types of the data stored in the verifiable credential.
|
|
|
34
34
|
|
|
35
35
|
### holder? {#holder}
|
|
36
36
|
|
|
37
|
-
> `optional` **holder
|
|
37
|
+
> `optional` **holder?**: `string`
|
|
38
38
|
|
|
39
39
|
The entity generating the presentation.
|
|
40
40
|
|
|
@@ -46,7 +46,7 @@ The entity generating the presentation.
|
|
|
46
46
|
|
|
47
47
|
### proof? {#proof}
|
|
48
48
|
|
|
49
|
-
> `optional` **proof
|
|
49
|
+
> `optional` **proof?**: `ObjectOrArray`\<[`IProof`](../type-aliases/IProof.md)\>
|
|
50
50
|
|
|
51
51
|
Proofs that the verifiable presentation is valid.
|
|
52
52
|
Optional if a different proof method is used, such as JWT.
|
|
@@ -67,6 +67,6 @@ The context for the verifiable presentation.
|
|
|
67
67
|
|
|
68
68
|
### verifiableCredential? {#verifiablecredential}
|
|
69
69
|
|
|
70
|
-
> `optional` **verifiableCredential
|
|
70
|
+
> `optional` **verifiableCredential?**: (`string` \| [`IDidVerifiableCredentialV2`](IDidVerifiableCredentialV2.md))[]
|
|
71
71
|
|
|
72
72
|
The data for the verifiable credentials.
|
|
@@ -7,7 +7,7 @@ https://www.w3.org/TR/vc-jws-2020/
|
|
|
7
7
|
|
|
8
8
|
### @context? {#context}
|
|
9
9
|
|
|
10
|
-
> `optional` **@context
|
|
10
|
+
> `optional` **@context?**: `"https://w3id.org/security/suites/jws-2020/v1"` \| `SingleOccurrenceArray`\<`IJsonLdContextDefinitionElement`, `"https://w3id.org/security/suites/jws-2020/v1"`\>
|
|
11
11
|
|
|
12
12
|
JSON-LD Context.
|
|
13
13
|
|
|
@@ -31,7 +31,7 @@ The reason the proof was created.
|
|
|
31
31
|
|
|
32
32
|
### verificationMethod? {#verificationmethod}
|
|
33
33
|
|
|
34
|
-
> `optional` **verificationMethod
|
|
34
|
+
> `optional` **verificationMethod?**: `string`
|
|
35
35
|
|
|
36
36
|
The verification method of the proof.
|
|
37
37
|
|
|
@@ -39,7 +39,7 @@ The verification method of the proof.
|
|
|
39
39
|
|
|
40
40
|
### created? {#created}
|
|
41
41
|
|
|
42
|
-
> `optional` **created
|
|
42
|
+
> `optional` **created?**: `string`
|
|
43
43
|
|
|
44
44
|
The iso date of when the proof was created.
|
|
45
45
|
|
|
@@ -47,6 +47,6 @@ The iso date of when the proof was created.
|
|
|
47
47
|
|
|
48
48
|
### jws? {#jws}
|
|
49
49
|
|
|
50
|
-
> `optional` **jws
|
|
50
|
+
> `optional` **jws?**: `string`
|
|
51
51
|
|
|
52
52
|
The JSON Web Signature.
|
|
@@ -7,7 +7,7 @@ https://www.w3.org/TR/cid-1.0/
|
|
|
7
7
|
|
|
8
8
|
### @context? {#context}
|
|
9
9
|
|
|
10
|
-
> `optional` **@context
|
|
10
|
+
> `optional` **@context?**: `"https://www.w3.org/ns/cid/v1"` \| `"https://w3id.org/security/multikey/v1"` \| `SingleOccurrenceArray`\<`IJsonLdContextDefinitionElement`, `"https://www.w3.org/ns/cid/v1"`\> \| `SingleOccurrenceArray`\<`IJsonLdContextDefinitionElement`, `"https://w3id.org/security/multikey/v1"`\>
|
|
11
11
|
|
|
12
12
|
JSON-LD Context.
|
|
13
13
|
|
|
@@ -15,7 +15,7 @@ JSON-LD Context.
|
|
|
15
15
|
|
|
16
16
|
### id? {#id}
|
|
17
17
|
|
|
18
|
-
> `optional` **id
|
|
18
|
+
> `optional` **id?**: `string`
|
|
19
19
|
|
|
20
20
|
The id of the entry.
|
|
21
21
|
|
|
@@ -31,7 +31,7 @@ The type of the entry.
|
|
|
31
31
|
|
|
32
32
|
### controller? {#controller}
|
|
33
33
|
|
|
34
|
-
> `optional` **controller
|
|
34
|
+
> `optional` **controller?**: `string`
|
|
35
35
|
|
|
36
36
|
The controller for the entry.
|
|
37
37
|
|
|
@@ -47,7 +47,7 @@ The public key for the entry.
|
|
|
47
47
|
|
|
48
48
|
### secretKeyMultibase? {#secretkeymultibase}
|
|
49
49
|
|
|
50
|
-
> `optional` **secretKeyMultibase
|
|
50
|
+
> `optional` **secretKeyMultibase?**: `string`
|
|
51
51
|
|
|
52
52
|
The secret key for the entry.
|
|
53
53
|
|
|
@@ -55,7 +55,7 @@ The secret key for the entry.
|
|
|
55
55
|
|
|
56
56
|
### expires? {#expires}
|
|
57
57
|
|
|
58
|
-
> `optional` **expires
|
|
58
|
+
> `optional` **expires?**: `string`
|
|
59
59
|
|
|
60
60
|
The date the entry expires.
|
|
61
61
|
|
|
@@ -63,6 +63,6 @@ The date the entry expires.
|
|
|
63
63
|
|
|
64
64
|
### revoked? {#revoked}
|
|
65
65
|
|
|
66
|
-
> `optional` **revoked
|
|
66
|
+
> `optional` **revoked?**: `string`
|
|
67
67
|
|
|
68
68
|
The date the entry was revoked.
|