Skip to main content

credential-request-code-snippet

CredentialRequest
{
  type: string, // the type of credential data being requested
  issuers: string[], // list of acceptable brandIds; if empty, all issuer brands are valid
  required?: boolean, // @deprecated - Use mandatory field instead. If the credential is required
  mandatory?: 'yes' | 'no' | 'if_available' // if the credential is required, not required, or required if available.
  description?: string // a description field that is shown to the user; can be used to explain why the information is being requested
  allowUserInput?: boolean // when true, the user will be shown an input to add their own information if they choose.
  children?: CredentialRequest[] // list of sub-credentials relevant to the parent credential (e.g. FullNameCredential(FirstNameCredential, MiddleNameCredential LastNameCredential)
}