Skip to main content
Credential offers

Receive credential

POST/v4/config/ows/holder/credentials

Takes a credential offer into the organisation wallet over OpenID4VCI 1.0, or starts a wallet-initiated issuance. The wallet reads the Credential Issuer Metadata, gets the token and asks for the credential with the holder key of the organisation (the request has no key field).

Send one of two bodies:

  • Credential offer: credentialOffer, the offer link (QR code) of the issuer.
  • Wallet-initiated issuance: credentialIssuer and credentialConfigurationIds. The wallet makes the offer itself and starts the Authorization Code Flow.

Then read credentialStatus of each record in the answer:

Each new record makes a wallet notification and the holder event ows.holder.credential.created (pending) or ows.holder.credential.received.

The holder operations work for the main organisation only: a sandbox organisation has no holder wallet. Most of them also need an operational wallet unit (see Read wallet unit status).

Authorizations

  • Authorizationstringheaderrequired

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

    Scope:credentials:receive

Body

application/json

The credential offer, or the issuer and the credential configurations of a wallet-initiated issuance.

  • credentialOfferstring

    The credential offer link of the issuer, with its credential_offer_uri (offer by reference) or credential_offer (offer by value) query parameter, for example openid-credential-offer://?credential_offer_uri=.... A URL without one of these parameters gives HTTP 400. Leave out credentialIssuer and credentialConfigurationIds when you send it.

    Example:"openid-credential-offer://?credential_offer_uri=https://demo-api.igrant.io/organisation/0f9b1c2d-3e4a-4b6c-8d8e-9f0a1b2c3d4e/service/credential-offer/6650d3c3-b8b1-4c2a-91f0-d9e4c7a2b5f8"

  • credentialIssuerstring

    For a wallet-initiated issuance: the Credential Issuer Identifier, or the URL of its .well-known/openid-credential-issuer metadata. The credential_issuer of the metadata must be exactly this identifier.

    Example:"https://demo-api.igrant.io/organisation/0f9b1c2d-3e4a-4b6c-8d8e-9f0a1b2c3d4e/service/version-01"

  • credentialConfigurationIdsstring[]

    For a wallet-initiated issuance: one or more keys of credential_configurations_supported of the issuer. Get them with Read credential issuer metadata.

Response

application/json

The credential records that the wallet made.

  • credentialobject or any[] | null

    One credential record, an array when the wallet made more than one record (for example an offer of several credential configurations), or null when it made none.