Function createCredentialResponse

createCredentialResponse(
    options:
        | { flow: ImmediateFlowOptions } & Omit<
            CreateCredentialResponseOptionsV1_0,
            "flow",
        >
        | { flow: ImmediateFlowOptions } & Omit<
            CreateCredentialResponseOptionsV1_3,
            "flow",
        >,
): Promise<
    CreateCredentialResponseResultWithFlow<
        { credentials: { credential: string }[]; notification_id?: string },
    >,
>

Creates a credential response according to the configured Italian Wallet specification version.

Supports both immediate and deferred issuance flows, with optional JWE encryption of the generated response payload.

Version Differences:

v1.0 deferred flow uses lead_time
v1.3 deferred flow uses interval
immediate flow has the same shape in both versions (credentials, optional notification_id)

Parameters

options:
    | { flow: ImmediateFlowOptions } & Omit<
        CreateCredentialResponseOptionsV1_0,
        "flow",
    >
    | { flow: ImmediateFlowOptions } & Omit<
        CreateCredentialResponseOptionsV1_3,
        "flow",
    >
Credential response creation options, including version config, flow data, and optional encryption settings.

Returns Promise<
    CreateCredentialResponseResultWithFlow<
        { credentials: { credential: string }[]; notification_id?: string },
    >,
>

An object containing:

credentialResponse: plain version-specific credential response JSON
credentialResponseJwt: encrypted JWE string when encryption is requested

Throws

When the generated response does not satisfy the version schema.

Throws

When encryption is requested but callbacks.encryptJwe is not provided.

Throws

For unexpected errors during response creation.

Example

v1.0 - Immediate flow without encryption
const config = new IoWalletSdkConfig({ itWalletSpecsVersion: ItWalletSpecsVersion.V1_0 });
const result = await createCredentialResponse({
  config,
  flow: {
    credentials: [{ credential: "eyJ..." }],
    notificationId: "notif-123",
  },
});
// result.credentialResponse = { credentials: [{ credential: "eyJ..." }], notification_id: "notif-123" }
// result.credentialResponseJwt = undefined

Example

v1.3 - Immediate flow with encryption
const config = new IoWalletSdkConfig({ itWalletSpecsVersion: ItWalletSpecsVersion.V1_3 });
const result = await createCredentialResponse({
  callbacks: { encryptJwe: myEncryptJweCallback },
  config,
  credentialResponseEncryption: {
    alg: "ECDH-ES",
    enc: "A256GCM",
    jwk: issuerEncryptionPublicJwk,
  },
  flow: {
    credentials: [{ credential: "eyJ..." }],
  },
});
// result.credentialResponse contains plain JSON
// result.credentialResponseJwt contains encrypted JWE

Example

v1.0 - Deferred flow without encryption
const config = new IoWalletSdkConfig({ itWalletSpecsVersion: ItWalletSpecsVersion.V1_0 });
const result = await createCredentialResponse({
  config,
  flow: {
    leadTime: 300,
    transactionId: "tx-v1-0",
  },
});
// result.credentialResponse = { lead_time: 300, transaction_id: "tx-v1-0" }

Example

v1.3 - Deferred flow with encryption
const config = new IoWalletSdkConfig({ itWalletSpecsVersion: ItWalletSpecsVersion.V1_3 });
const result = await createCredentialResponse({
  callbacks: { encryptJwe: myEncryptJweCallback },
  config,
  credentialResponseEncryption: {
    alg: "ECDH-ES",
    enc: "A256GCM",
    jwk: issuerEncryptionPublicJwk,
  },
  flow: {
    interval: 60,
    transactionId: "tx-v1-3",
  },
});
// result.credentialResponse = { interval: 60, transaction_id: "tx-v1-3" }
// result.credentialResponseJwt contains encrypted JWE

createCredentialResponse(
    options: { flow: DeferredFlowOptionsV1_0 } & Omit<
        CreateCredentialResponseOptionsV1_0,
        "flow",
    >,
): Promise<
    CreateCredentialResponseResultWithFlow<
        { lead_time: number; transaction_id: string },
    >,
>

Creates a credential response according to the configured Italian Wallet specification version.

Supports both immediate and deferred issuance flows, with optional JWE encryption of the generated response payload.

Version Differences:

v1.0 deferred flow uses lead_time
v1.3 deferred flow uses interval
immediate flow has the same shape in both versions (credentials, optional notification_id)

Parameters

options: { flow: DeferredFlowOptionsV1_0 } & Omit<
CreateCredentialResponseOptionsV1_0,
"flow",
>
Credential response creation options, including version config, flow data, and optional encryption settings.

Returns Promise<
    CreateCredentialResponseResultWithFlow<
        { lead_time: number; transaction_id: string },
    >,
>

An object containing:

credentialResponse: plain version-specific credential response JSON
credentialResponseJwt: encrypted JWE string when encryption is requested

Throws

When the generated response does not satisfy the version schema.

Throws

When encryption is requested but callbacks.encryptJwe is not provided.

Throws

For unexpected errors during response creation.

Example

v1.0 - Immediate flow without encryption
const config = new IoWalletSdkConfig({ itWalletSpecsVersion: ItWalletSpecsVersion.V1_0 });
const result = await createCredentialResponse({
  config,
  flow: {
    credentials: [{ credential: "eyJ..." }],
    notificationId: "notif-123",
  },
});
// result.credentialResponse = { credentials: [{ credential: "eyJ..." }], notification_id: "notif-123" }
// result.credentialResponseJwt = undefined

Example

v1.3 - Immediate flow with encryption
const config = new IoWalletSdkConfig({ itWalletSpecsVersion: ItWalletSpecsVersion.V1_3 });
const result = await createCredentialResponse({
  callbacks: { encryptJwe: myEncryptJweCallback },
  config,
  credentialResponseEncryption: {
    alg: "ECDH-ES",
    enc: "A256GCM",
    jwk: issuerEncryptionPublicJwk,
  },
  flow: {
    credentials: [{ credential: "eyJ..." }],
  },
});
// result.credentialResponse contains plain JSON
// result.credentialResponseJwt contains encrypted JWE

Example

v1.0 - Deferred flow without encryption
const config = new IoWalletSdkConfig({ itWalletSpecsVersion: ItWalletSpecsVersion.V1_0 });
const result = await createCredentialResponse({
  config,
  flow: {
    leadTime: 300,
    transactionId: "tx-v1-0",
  },
});
// result.credentialResponse = { lead_time: 300, transaction_id: "tx-v1-0" }

Example

v1.3 - Deferred flow with encryption
const config = new IoWalletSdkConfig({ itWalletSpecsVersion: ItWalletSpecsVersion.V1_3 });
const result = await createCredentialResponse({
  callbacks: { encryptJwe: myEncryptJweCallback },
  config,
  credentialResponseEncryption: {
    alg: "ECDH-ES",
    enc: "A256GCM",
    jwk: issuerEncryptionPublicJwk,
  },
  flow: {
    interval: 60,
    transactionId: "tx-v1-3",
  },
});
// result.credentialResponse = { interval: 60, transaction_id: "tx-v1-3" }
// result.credentialResponseJwt contains encrypted JWE

createCredentialResponse(
    options: { flow: DeferredFlowOptionsV1_3 } & Omit<
        CreateCredentialResponseOptionsV1_3,
        "flow",
    >,
): Promise<
    CreateCredentialResponseResultWithFlow<
        { interval: number; transaction_id: string },
    >,
>

Creates a credential response according to the configured Italian Wallet specification version.

Supports both immediate and deferred issuance flows, with optional JWE encryption of the generated response payload.

Version Differences:

v1.0 deferred flow uses lead_time
v1.3 deferred flow uses interval
immediate flow has the same shape in both versions (credentials, optional notification_id)

Parameters

options: { flow: DeferredFlowOptionsV1_3 } & Omit<
CreateCredentialResponseOptionsV1_3,
"flow",
>
Credential response creation options, including version config, flow data, and optional encryption settings.

Returns Promise<
    CreateCredentialResponseResultWithFlow<
        { interval: number; transaction_id: string },
    >,
>

An object containing:

credentialResponse: plain version-specific credential response JSON
credentialResponseJwt: encrypted JWE string when encryption is requested

Throws

When the generated response does not satisfy the version schema.

Throws

When encryption is requested but callbacks.encryptJwe is not provided.

Throws

For unexpected errors during response creation.

Example

v1.0 - Immediate flow without encryption
const config = new IoWalletSdkConfig({ itWalletSpecsVersion: ItWalletSpecsVersion.V1_0 });
const result = await createCredentialResponse({
  config,
  flow: {
    credentials: [{ credential: "eyJ..." }],
    notificationId: "notif-123",
  },
});
// result.credentialResponse = { credentials: [{ credential: "eyJ..." }], notification_id: "notif-123" }
// result.credentialResponseJwt = undefined

Example

v1.3 - Immediate flow with encryption
const config = new IoWalletSdkConfig({ itWalletSpecsVersion: ItWalletSpecsVersion.V1_3 });
const result = await createCredentialResponse({
  callbacks: { encryptJwe: myEncryptJweCallback },
  config,
  credentialResponseEncryption: {
    alg: "ECDH-ES",
    enc: "A256GCM",
    jwk: issuerEncryptionPublicJwk,
  },
  flow: {
    credentials: [{ credential: "eyJ..." }],
  },
});
// result.credentialResponse contains plain JSON
// result.credentialResponseJwt contains encrypted JWE

Example

v1.0 - Deferred flow without encryption
const config = new IoWalletSdkConfig({ itWalletSpecsVersion: ItWalletSpecsVersion.V1_0 });
const result = await createCredentialResponse({
  config,
  flow: {
    leadTime: 300,
    transactionId: "tx-v1-0",
  },
});
// result.credentialResponse = { lead_time: 300, transaction_id: "tx-v1-0" }

Example

v1.3 - Deferred flow with encryption
const config = new IoWalletSdkConfig({ itWalletSpecsVersion: ItWalletSpecsVersion.V1_3 });
const result = await createCredentialResponse({
  callbacks: { encryptJwe: myEncryptJweCallback },
  config,
  credentialResponseEncryption: {
    alg: "ECDH-ES",
    enc: "A256GCM",
    jwk: issuerEncryptionPublicJwk,
  },
  flow: {
    interval: 60,
    transactionId: "tx-v1-3",
  },
});
// result.credentialResponse = { interval: 60, transaction_id: "tx-v1-3" }
// result.credentialResponseJwt contains encrypted JWE

createCredentialResponse(
options: CreateCredentialResponseOptions,
): Promise<CreateCredentialResponseResult>

Creates a credential response according to the configured Italian Wallet specification version.

Supports both immediate and deferred issuance flows, with optional JWE encryption of the generated response payload.

Version Differences:

v1.0 deferred flow uses lead_time
v1.3 deferred flow uses interval
immediate flow has the same shape in both versions (credentials, optional notification_id)

Parameters

options: CreateCredentialResponseOptions
Credential response creation options, including version config, flow data, and optional encryption settings.

Returns Promise<CreateCredentialResponseResult>

An object containing:

credentialResponse: plain version-specific credential response JSON
credentialResponseJwt: encrypted JWE string when encryption is requested

Throws

When the generated response does not satisfy the version schema.

Throws

When encryption is requested but callbacks.encryptJwe is not provided.

Throws

For unexpected errors during response creation.

Example

v1.0 - Immediate flow without encryption
const config = new IoWalletSdkConfig({ itWalletSpecsVersion: ItWalletSpecsVersion.V1_0 });
const result = await createCredentialResponse({
  config,
  flow: {
    credentials: [{ credential: "eyJ..." }],
    notificationId: "notif-123",
  },
});
// result.credentialResponse = { credentials: [{ credential: "eyJ..." }], notification_id: "notif-123" }
// result.credentialResponseJwt = undefined

Example

v1.3 - Immediate flow with encryption
const config = new IoWalletSdkConfig({ itWalletSpecsVersion: ItWalletSpecsVersion.V1_3 });
const result = await createCredentialResponse({
  callbacks: { encryptJwe: myEncryptJweCallback },
  config,
  credentialResponseEncryption: {
    alg: "ECDH-ES",
    enc: "A256GCM",
    jwk: issuerEncryptionPublicJwk,
  },
  flow: {
    credentials: [{ credential: "eyJ..." }],
  },
});
// result.credentialResponse contains plain JSON
// result.credentialResponseJwt contains encrypted JWE

Example

v1.0 - Deferred flow without encryption
const config = new IoWalletSdkConfig({ itWalletSpecsVersion: ItWalletSpecsVersion.V1_0 });
const result = await createCredentialResponse({
  config,
  flow: {
    leadTime: 300,
    transactionId: "tx-v1-0",
  },
});
// result.credentialResponse = { lead_time: 300, transaction_id: "tx-v1-0" }

Example

v1.3 - Deferred flow with encryption
const config = new IoWalletSdkConfig({ itWalletSpecsVersion: ItWalletSpecsVersion.V1_3 });
const result = await createCredentialResponse({
  callbacks: { encryptJwe: myEncryptJweCallback },
  config,
  credentialResponseEncryption: {
    alg: "ECDH-ES",
    enc: "A256GCM",
    jwk: issuerEncryptionPublicJwk,
  },
  flow: {
    interval: 60,
    transactionId: "tx-v1-3",
  },
});
// result.credentialResponse = { interval: 60, transaction_id: "tx-v1-3" }
// result.credentialResponseJwt contains encrypted JWE

Function createCredentialResponse

Parameters

Returns Promise< CreateCredentialResponseResultWithFlow< { credentials: { credential: string }[]; notification_id?: string }, >,>

Throws

Throws

Throws

Example

Example

Example

Example

Parameters

Returns Promise< CreateCredentialResponseResultWithFlow< { lead_time: number; transaction_id: string }, >,>

Throws

Throws

Throws

Example

Example

Example

Example

Parameters

Returns Promise< CreateCredentialResponseResultWithFlow< { interval: number; transaction_id: string }, >,>

Throws

Throws

Throws

Example

Example

Example

Example

Parameters

Returns Promise<CreateCredentialResponseResult>

Throws

Throws

Throws

Example

Example

Example

Example

Settings

Returns Promise<
CreateCredentialResponseResultWithFlow<
{ credentials: { credential: string }[]; notification_id?: string },
>,
>

Returns Promise<
CreateCredentialResponseResultWithFlow<
{ lead_time: number; transaction_id: string },
>,
>

Returns Promise<
CreateCredentialResponseResultWithFlow<
{ interval: number; transaction_id: string },
>,
>