Skip to main content

ICredentialRequestInput interface

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Describes a particular credential that is being requested

Signature:

export interface ICredentialRequestInput

Remarks

See Selective Disclosure Request

This API may change without a BREAKING CHANGE notice.

Properties

PropertyModifiersTypeDescription
claimTypestring(BETA) The name of the claim property that the credential should express.
claimValue?string(BETA) (Optional) The value of the claim that the credential should express.
credentialContext?string(BETA) (Optional) The credential context. See W3C Credential Context
credentialType?string(BETA) (Optional) The credential type. See W3C Credential Types
essential?boolean(BETA) (Optional) If it is essential. A response that does not include this credential is not sufficient.
issuers?Issuer[](BETA) (Optional) A list of accepted Issuers for this credential.
reason?string(BETA) (Optional) Motive for requiring this credential.