{"_id":"@aries-framework/openid4vc-client","_rev":"209-71f4071c6c584a707231a5cf35dd308a","name":"@aries-framework/openid4vc-client","dist-tags":{"alpha":"0.5.0-alpha.97","latest":"0.4.2"},"versions":{"0.3.3-alpha.9":{"name":"@aries-framework/openid4vc-client","main":"build/index","types":"build/index","version":"0.3.3-alpha.9","license":"Apache-2.0","publishConfig":{"access":"public"},"homepage":"https://github.com/hyperledger/aries-framework-javascript/tree/main/packages/openid4vc-client","repository":{"type":"git","url":"git+https://github.com/hyperledger/aries-framework-javascript.git","directory":"packages/openid4vc-client"},"scripts":{"build":"yarn run clean && yarn run compile","clean":"rimraf -rf ./build","compile":"tsc -p tsconfig.build.json","prepublishOnly":"yarn run build","test":"jest"},"dependencies":{"@aries-framework/core":"0.3.3-alpha.9+b6f89f9","@sphereon/openid4vci-client":"^0.3.6","class-transformer":"0.5.1","class-validator":"0.13.1"},"devDependencies":{"@aries-framework/node":"0.3.3-alpha.9+b6f89f9","reflect-metadata":"^0.1.13","rimraf":"~3.0.2","typescript":"~4.3.0"},"gitHead":"b6f89f943dc4417626f868ac9f43a3d890ab62c6","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger

\n
\n \n

\n

Aries Framework JavaScript Open ID Connect For Verifiable Credentials Client Module

\n

\n \n \n \n\n

\n
\n\nOpen ID Connect For Verifiable Credentials Client Module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript).\n\n### Installation\n\nMake sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository.\n\n```sh\nyarn add @aries-framework/openid4vc-client\n```\n\n### Quick start\n\n#### Requirements\n\nBefore a credential can be requested, you need the issuer URI. This URI starts with `openid-initiate-issuance://` and is provided by the issuer. The issuer URI is commonly acquired by scanning a QR code.\n\n#### Module registration\n\nIn order to get this module to work, we need to inject it into the agent. This makes the module's functionality accessible through the agent's `modules` api.\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\n\nconst agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n})\n\nawait agent.initialize()\n```\n\nHow the module is injected and the agent has been initialized, you can access the module's functionality through `agent.modules.openId4VcClient`.\n\n#### Preparing a DID\n\nIn order to request a credential, you'll need to provide a DID that the issuer will use for setting the credential subject. In the following snippet we create one for the sake of the example, but this can be any DID that has a _authentication verification method_ with key type `Ed25519`.\n\n```ts\n// first we create the DID\nconst did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n})\n\n// next we do some assertions and extract the key identifier (kid)\n\nif (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n}\n\nconst [verificationMethod] = did.didState.didDocument.authentication\nconst kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n```\n\n#### Requesting the credential (Pre-Authorized)\n\nNow a credential issuance can be requested as follows.\n\n```ts\nconst w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n})\n\nconsole.log(w3cCredentialRecord)\n```\n\n#### Full example\n\n```ts\nimport { OpenId4VcClientModule } from '@aries-framework/openid4vc-client'\nimport { agentDependencies } from '@aries-framework/node' // use @aries-framework/react-native for React Native\nimport { Agent, KeyDidCreateOptions } from '@aries-framework/core'\n\nconst run = async () => {\n const issuerUri = '' // The obtained issuer URI\n\n // Create the Agent\n const agent = new Agent({\n config: {\n /* config */\n },\n dependencies: agentDependencies,\n modules: {\n openId4VcClient: new OpenId4VcClientModule(),\n /* other custom modules */\n },\n })\n\n // Initialize the Agent\n await agent.initialize()\n\n // Create a DID\n const did = await agent.dids.create({\n method: 'key',\n options: {\n keyType: KeyType.Ed25519,\n },\n })\n\n // Assert DIDDocument is valid\n if (\n !did.didState.didDocument ||\n !did.didState.didDocument.authentication ||\n did.didState.didDocument.authentication.length === 0\n ) {\n throw new Error(\"Error creating did document, or did document has no 'authentication' verificationMethods\")\n }\n\n // Extract key identified (kid) for authentication verification method\n const [verificationMethod] = did.didState.didDocument.authentication\n const kid = typeof verificationMethod === 'string' ? verificationMethod : verificationMethod.id\n\n // Request the credential\n const w3cCredentialRecord = await agent.modules.openId4VcClient.requestCredentialPreAuthorized({\n issuerUri,\n kid,\n checkRevocationState: false,\n })\n\n // Log the received credential\n console.log(w3cCredentialRecord)\n}\n```\n","readmeFilename":"README.md","description":"


\"Hyperledger


\"Hyperledger