Function parseCredentialOfferUri

parseCredentialOfferUri(
    options: ParseCredentialOfferUriOptions,
): Promise<
    {
        credential_offer?: string;
        credential_offer_uri?: string;
        scheme: "openid-credential-offer"
        | "haip-vci"
        | "https";
    },
>
Parses a credential offer URI and extracts the scheme and parameters.

This function supports three URL schemes for credential offers:
- openid-credential-offer:// - Standard OpenID scheme (custom URL scheme)
- haip-vci:// - High Assurance Interoperability Profile scheme (custom URL scheme)
- https:// - HTTPS Universal Links (preferred method)
Credential offers can be transmitted in two ways:
- By value: The credential_offer parameter contains the JSON directly (URL-encoded)
- By reference: The credential_offer_uri parameter points to a URL where the JSON can be fetched
Parameters
- options: ParseCredentialOfferUriOptions
  Parsing options containing the URI and allowed schemes
Returns Promise<
    {
        credential_offer?: string;
        credential_offer_uri?: string;
        scheme: "openid-credential-offer"
        | "haip-vci"
        | "https";
    },
>
Parsed credential offer URI components with scheme and parameters
Throws
If the URI is invalid, uses an unsupported scheme, or is missing required parameters
Example: Parse by-value offer with custom scheme
```
const parsed = await parseCredentialOfferUri({
  uri: "openid-credential-offer://?credential_offer=%7B%22credential_issuer%22%3A..."
});
console.log(parsed.scheme); // "openid-credential-offer"
console.log(parsed.credential_offer); // URL-decoded JSON string
```
Example: Parse by-reference offer with HTTPS Universal Link
```
const parsed = await parseCredentialOfferUri({
  uri: "https://wallet.example.com/credential-offer?credential_offer_uri=https://issuer.example.com/offers/123"
});
console.log(parsed.scheme); // "https"
console.log(parsed.credential_offer_uri); // "https://issuer.example.com/offers/123"
```
Example: Restrict allowed schemes
```
const parsed = await parseCredentialOfferUri({
  uri: "openid-credential-offer://?credential_offer=...",
  allowedSchemes: ["openid-credential-offer"] // Only allow standard OpenID scheme
});
```
- Defined in packages/oid4vci/src/credential-offer/parse-credential-offer-uri.ts:51

Function parseCredentialOfferUri

Parameters

Returns Promise< { credential_offer?: string; credential_offer_uri?: string; scheme: "openid-credential-offer" | "haip-vci" | "https"; },>

Throws

Example: Parse by-value offer with custom scheme

Example: Parse by-reference offer with HTTPS Universal Link

Example: Restrict allowed schemes

Settings

Returns Promise<
{
credential_offer?: string;
credential_offer_uri?: string;
scheme: "openid-credential-offer"
| "haip-vci"
| "https";
},
>