Module: issue#

References#

default#

Renames and re-exports issueVerifiableCredential

Functions#

issueVerifiableCredential#

▸ issueVerifiableCredential(issuerEndpoint, subjectClaims, credentialClaims?, options?): Promise<VerifiableCredential>

Request that a given Verifiable Credential (VC) Issuer issues a VC containing the provided claims. The VC Issuer is expected to implement the W3C VC Issuer HTTP API.

Parameters#

Name	Type	Description
`issuerEndpoint`	`string`	The `/issue` endpoint of the VC Issuer.
`subjectClaims`	`JsonLd`	Claims about the subject that will be attested by the VC.
`credentialClaims?`	`JsonLd`	Claims about the credential itself, rather than its subject, e.g. credential type or expiration.
`options?`	`OptionsType`	Optional parameter `options.fetch`: An alternative `fetch` function to make the HTTP request, compatible with the browser-native fetch API. This can be typically used for authentication. Note that if it is omitted, and `@inrupt/solid-client-authn-browser` is in your dependencies, the default session is picked up.

Returns#

Promise<VerifiableCredential>

the VC returned by the Issuer if the request is successful. Otherwise, an error is thrown.

Since

0.1.0

Defined in#

src/issue/issue.ts:132

▸ issueVerifiableCredential(issuerEndpoint, subjectId, subjectClaims, credentialClaims?, options?): Promise<VerifiableCredential>

Parameters#

Name	Type
`issuerEndpoint`	`string`
`subjectId`	`string`
`subjectClaims`	`JsonLd`
`credentialClaims?`	`JsonLd`
`options?`	`OptionsType`

Returns#

Promise<VerifiableCredential>

Deprecated

Please remove the subjectId parameter

Defined in#

src/issue/issue.ts:141