Skip to main content
Held credentials

List credentials

GET/v4/config/ows/holder/credentials

Lists the credentials that the organisation wallet holds, one page at a time. The list leaves out deleted credentials and puts the Wallet Unit Attestations last. Filter by status, type, expiry, ids, the reception of an offer or a search term, and choose the sort field and order. With groupBatches=true the list gives one row for each batch issuance. A query value that the wallet cannot read counts as not sent: the wallet does not refuse the request for it.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:credentials:read

Query parameters

  • offsetinteger

    Number of records to skip for pagination. A negative or unreadable value falls back to 0.

    At least 0.

    Default:0

  • limitinteger

    Maximum number of records to return per page.

    Default:10

  • expiredboolean

    true gives only the expired credentials: revoked, archived (a replaced Wallet Unit Attestation) or after the end of their validity. false gives only the other credentials. A pending credential is never expired. Not sent: no filter.

  • searchstring

    Text to find, without regard to case, in the vct, the mDoc doctype or the W3C credential type of the credential, or in the issuer name.

  • sortByenum<string>

    Sort field: updatedAt (default) or createdAt.

    Available options:updatedAt,createdAt

    Default:updatedAt

  • sortOrderenum<string>

    Sort order: desc (default, newest first) or asc (oldest first). Any other value is desc.

    Available options:desc,asc

    Default:desc

  • groupBatchesboolean

    true gives one row for each batch issuance: the first copy that the wallet did not present yet (else the first copy), with batchInstanceCount and batchAvailableCount. A credential outside a batch is a group of one. The pagination counts these rows. Any other value is false.

    Default:false

  • credentialStatusstring

    Gives only the credentials with this status: credential_pending, credential_acked, credential_accepted or credential_archived. Give one value or a comma-separated list.

    Example:"credential_acked,credential_accepted"

  • idsstring

    Comma-separated credentialId values: gives only these credentials. A value that is not a UUID matches nothing.

    Example:"d29a6c1e-4b8f-4a1d-9c3e-7f5b2a0d8e11,5f6a7b8c-9d0e-4f1a-2b3c-4d5e6f7a8b9c"

  • receivedOfferIdstring

    Gives only the credentials of one reception of a credential offer: the receivedOfferId of a record, for example from the answer of Receive credential. A value that is not a UUID matches nothing.

    Example:"e3b54f0a-7c21-4d8e-9a6b-1f2c3d4e5f60"

  • vctstring

    Gives only the IETF SD-JWT VC credentials of this Verifiable Credential Type (vct of the credential configuration).

    Example:"urn:eudi:pid:1"

  • doctypestring

    Gives only the ISO/IEC 18013-5 mDoc credentials of this document type.

    Example:"org.iso.18013.5.1.mDL"

  • typestring

    Gives only the W3C VC credentials whose credential configuration has this type in credential_definition.type.

    Example:"VerifiableAttestation"

Response

application/json

A page of held credentials.

  • credentialobject[]

    The credential records of the page. Empty when no credential matches.

  • paginationobject

    The position of the page in the list.