Search credentials

Search and filter credentials retrieved from the /api/credential/v1 endpoint by using a combination of searchType and searchText:

• searchType - Choose any combination of categories to search
  • CLAIM_NAME searches the claim keys of credentials, such as Name or Nationality
  • CLAIM_VALUE searches the claim values of credentials, such as John or USA
  • CREDENTIAL_SCHEMA_NAME searches the names of the credential schemas, such as Driver's License or Residence Permit
• searchText - Full-text, case-sensitive search of the chosen categories

A credential will be returned if there is text match within the first 255 bytes in one of the chosen categories.

note

Searching credentials by name is deprecated and will return an error if combined with searching by searchType and searchText.

Credential roles

Every credential in the system belongs to one of three roles, indicated by the role field when retrieving credentials.

• ISSUER: Credentials issued by the system
• HOLDER: Credentials held by the system, as for a wallet
• VERIFIER: Credentials shared with the system as part of a proof request

Use the credential role to differentiate credentials by their origin in the system.