diff --git a/.gitbook/assets/sendgrid/sendgrid-create-api-key.png b/.gitbook/assets/sendgrid/sendgrid-create-api-key.png new file mode 100644 index 0000000..020d61b Binary files /dev/null and b/.gitbook/assets/sendgrid/sendgrid-create-api-key.png differ diff --git a/.gitbook/assets/sendgrid/sendgrid-create-view.png b/.gitbook/assets/sendgrid/sendgrid-create-view.png new file mode 100644 index 0000000..7947d0a Binary files /dev/null and b/.gitbook/assets/sendgrid/sendgrid-create-view.png differ diff --git a/.gitbook/assets/sendgrid/sendgrid-key-reveal.png b/.gitbook/assets/sendgrid/sendgrid-key-reveal.png new file mode 100644 index 0000000..9135923 Binary files /dev/null and b/.gitbook/assets/sendgrid/sendgrid-key-reveal.png differ diff --git a/.gitbook/assets/sendgrid/sendgrid-login.png b/.gitbook/assets/sendgrid/sendgrid-login.png new file mode 100644 index 0000000..421043d Binary files /dev/null and b/.gitbook/assets/sendgrid/sendgrid-login.png differ diff --git a/.gitbook/assets/sendgrid/sendgrid-settings-api-keys.png b/.gitbook/assets/sendgrid/sendgrid-settings-api-keys.png new file mode 100644 index 0000000..8610a08 Binary files /dev/null and b/.gitbook/assets/sendgrid/sendgrid-settings-api-keys.png differ diff --git a/SUMMARY.md b/SUMMARY.md index da8aa32..b02ecb7 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -29,6 +29,9 @@ * [Architecture](references/architecture.md) * [Platform APIs](references/platform-apis.md) +* [OID4VC Issuer API](references/oid4vc/OID4VC%20Issuer%20API.md) +* [OID4VP Verifier API](references/oid4vc/CREDEBL%20OID4VP%20Verifier%20API.md) +* [Ecosystem & Trust Service](references/ecosystem/ecosystem.md) * [FAQs](references/faqs.md) * [Glossary](references/glossary.md) * [Copyright & License](references/copyright-and-license.md) diff --git a/contribute/setup/optional-agent.md b/contribute/setup/optional-agent.md index 574a4d7..a4c6098 100644 --- a/contribute/setup/optional-agent.md +++ b/contribute/setup/optional-agent.md @@ -34,17 +34,17 @@ Below is the cliConfig.json file, which needs to be used to set up the agent cliConfig.json -``` +```json { "label": "AFJ Rest Agent 1", - "walletId": "sample", # Mention your walletId here - "walletKey": "sample", # Mention your walletKey here - "walletType": "postgres", # Mention wallet type here - "walletUrl": "localhost:5432", # Mention your wallet url here - "walletAccount": "postgres", # Mention your wallet account name here - "walletPassword": "postgres", # Mention your wallet password here + "walletId": "sample", + "walletKey": "sample", + "walletType": "postgres", + "walletUrl": "localhost:5432", + "walletAccount": "postgres", + "walletPassword": "postgres", "walletAdminAccount": "postgres", - "walletAdminPassword": "postgres",, + "walletAdminPassword": "postgres", "walletScheme": "ProfilePerWallet", "indyLedger": [ { @@ -80,7 +80,7 @@ Below is the cliConfig.json file, which needs to be used to set up the agent "schemaManagerContractAddress": "0x4742d43C2dFCa5a1d4238240Afa8547Daf87Ee7a", "rpcUrl": "https://rpc-amoy.polygon.technology", "fileServerUrl": "https://schema.credebl.id", - "fileServerToken": #Use your token here + "fileServerToken": "" } ``` @@ -92,13 +92,13 @@ For polygon mainnet use these configuration ```json "didRegistryContractAddress": "0x0C16958c4246271622201101C83B9F0Fc7180d15", -"schemaManagerContractAddress": "0x4B16719E73949a62E9A7306F352ec73F1B143c27" +"schemaManagerContractAddress": "0x4B16719E73949a62E9A7306F352ec73F1B143c27", "rpcUrl": "https://polygon-rpc.com" ``` _**Description of Fields in cliConfig.json**_ -* **referringlabel:** A descriptive name for the agent configuration. +* **label:** A descriptive name for the agent configuration. * **walletId:** The identifier for the wallet used by the agent. * **walletKey:** The key or token used to access the wallet. * **walletType:** The type of wallet (e.g., PostgreSQL). diff --git a/contribute/setup/service-setup.md b/contribute/setup/service-setup.md index 4750ffd..30ae545 100644 --- a/contribute/setup/service-setup.md +++ b/contribute/setup/service-setup.md @@ -31,7 +31,7 @@ Here is the list of prerequisites software we will need for CREDEBL: * [PostgreSQL](service-setup.md#postgresql) (>= 14) * [NATS](service-setup.md#nats) (>= 2.6.4) * [REDIS](service-setup.md#redis) (>= 7.4) -* [Keycloak](service-setup.md#top) (>= 25.0.6) +* [Keycloak](service-setup.md#keycloak) (>= 25.0.6) * [Sendgrid](service-setup.md#sendgrid) * [AWS S3](service-setup.md#aws-s3) * [Schema file server](service-setup.md#schema-file-server-optional) (optional) @@ -60,7 +60,7 @@ If you want to know more about the environment variables, please refer to `.env. The email (SendGrid) and AWS S3 credentials can optionally be stored in an OpenBao server instead of the `.env` file. See [OpenBao Secret Storage](../../getting-started/local-deployment/openbao.md). {% endhint %} -Apart from the already present variables, you need to add few variables generated from the below prerequisites like the [PostgreSQL](service-setup.md#postgresql), [Keycloak](service-setup.md#top), [Sendgrid](service-setup.md#sendgrid), [AWS S3](service-setup.md#aws-s3), etc at the respective steps. +Apart from the already present variables, you need to add few variables generated from the below prerequisites like the [PostgreSQL](service-setup.md#postgresql), [Keycloak](service-setup.md#keycloak), [Sendgrid](service-setup.md#sendgrid), [AWS S3](service-setup.md#aws-s3), etc at the respective steps. ### PostgreSQL @@ -70,7 +70,7 @@ In case you already have PostgreSQL preinstalled on your machine, you can simply PostgreSQL is a powerful, open-source object-relational database system known for its robustness and advanced features. This guide provides instructions for installing and configuring PostgreSQL both natively and using Docker. Installing PostgreSQL -**Initially we'll need to install postures on the host or on docker** +**Initially we'll need to install PostgreSQL on the host or on Docker** {% tabs %} {% tab title="Ubuntu" %} @@ -594,7 +594,7 @@ AFJ_VERSION=credo-controller-0.5.3:latest Using these cookies, users can fetch their session details. * To fetch the session details, call the following API while passing the stored cookies in the request headers`:` * `/auth/sessionDetails` -* For more details visit this - [https://docs.credebl.id/docs/\~/revisions/IXcpHdsfgTsukxV376wG/references/releases/v.2.1.0](https://docs.credebl.id/docs/~/revisions/IXcpHdsfgTsukxV376wG/references/releases/v.2.1.0#sso-single-sign-on) +* For more details, see [SSO (Single Sign-On) in release v.2.1.0](../../references/releases/v.2.1.0.md#sso-single-sign-on). ## Installations @@ -614,7 +614,7 @@ Before you start the services make sure to update the `credebl-master-table.json }, -At the root of the [platfrom repo](service-setup.md#clone-repository): +At the root of the [platform repo](service-setup.md#clone-repository): ```sh cd libs/prisma-service diff --git a/contribute/setup/studio.md b/contribute/setup/studio.md index fa9113d..b055666 100644 --- a/contribute/setup/studio.md +++ b/contribute/setup/studio.md @@ -11,14 +11,14 @@ Clone the studio repository: Create a .env file and set the required environment variables as per the `.env.demo` file. -* Update the Keycloak +* Update the Keycloak - * For older version + * For versions before v2.1.0 * **`PUBLIC_KEYCLOAK_MANAGEMENT_CLIENT_SECRET`** - * For newer version (v2.1.0) + * For v2.1.0 and above * **`NEXT_PUBLIC_KEYCLOAK_MANAGEMENT_CLIENT_SECRET`** - You can get this value from your platform environment variables or directly from the Keyclock dashboard. + You can get this value from your platform environment variables or directly from the Keycloak dashboard. * In version v2.1.0, we have implemented NextAuth for SSO. To run the application, please refer to the `env.demo` file for the required NextAuth-related values. * `NEXTAUTH_SECRET` Generate this secret by referring [here](https://next-auth.js.org/configuration/options#nextauth_secret.) (Only for v2.1.0). * Add the backend URL for `PUBLIC_ALLOW_DOMAIN` diff --git a/getting-started/getting-started.md b/getting-started/getting-started.md index ff15854..5bc3a65 100644 --- a/getting-started/getting-started.md +++ b/getting-started/getting-started.md @@ -5,5 +5,5 @@ icon: star-shooting # Getting Started -
Platform APIsStart with your local setup of CREDEBL Platform platform-apis.md
StudioSetup CREDEBL studiostudio.md
Mobile SDKUnderstand and build identity wallet using SSI Mobile SDKmobile-sdk.md
+
PlatformStart with your local setup of CREDEBL Platform platform.md
StudioSetup CREDEBL studiostudio.md
Mobile SDKUnderstand and build identity wallet using SSI Mobile SDKmobile-sdk.md
diff --git a/getting-started/local-deployment/platform.md b/getting-started/local-deployment/platform.md index a21939c..2110e0e 100644 --- a/getting-started/local-deployment/platform.md +++ b/getting-started/local-deployment/platform.md @@ -43,10 +43,10 @@ Ensure these ports are not blocked by your firewall or occupied by other applica Here is the list of prerequisites we will need for CREDEBL: * [Docker / Docker compose](https://docs.docker.com/compose/install/standalone/)​ -* [PostgreSQL](https://app.gitbook.com/o/V2P788cbocWTT1Z5YOmy/s/nsdydI5ziLfZ8yT3e0r8/~/diff/~/changes/93/~/revisions/TgbJCysW7FmStzyIiou3/contribute/setup/postgresql) (>= 14) -* ​[NATS](https://app.gitbook.com/o/V2P788cbocWTT1Z5YOmy/s/nsdydI5ziLfZ8yT3e0r8/~/diff/~/changes/93/~/revisions/TgbJCysW7FmStzyIiou3/contribute/setup/nats) (>= 2.6.4) -* ​[REDIS](https://app.gitbook.com/o/V2P788cbocWTT1Z5YOmy/s/nsdydI5ziLfZ8yT3e0r8/~/diff/~/changes/93/~/revisions/TgbJCysW7FmStzyIiou3/contribute/setup/redis) (>= 7.4) -* ​[Keycloak](https://app.gitbook.com/o/V2P788cbocWTT1Z5YOmy/s/nsdydI5ziLfZ8yT3e0r8/~/diff/~/changes/93/~/revisions/TgbJCysW7FmStzyIiou3/contribute/setup/top) (>= 25.0.6) +* [PostgreSQL](../../contribute/setup/service-setup.md#postgresql) (>= 14) +* ​[NATS](../../contribute/setup/service-setup.md#nats) (>= 2.6.4) +* ​[REDIS](../../contribute/setup/service-setup.md#redis) (>= 7.4) +* ​[Keycloak](../../contribute/setup/service-setup.md#keycloak) (>= 25.0.6) * [AWS S3 Configuration Requirements](https://aws.amazon.com/) * The platform uses Amazon S3 for secure file storage. Prepare your: * AWS Access Key ID @@ -101,18 +101,18 @@ Your SendGrid API key can optionally be stored in an OpenBao server instead of t * Log in to your SendGrid account: * Go to [https://app.sendgrid.com](https://login.sendgrid.com/login/password) and sign in with your credentials. -![](https://lh7-rt.googleusercontent.com/docsz/AD_4nXdmnR2ZTjWIr9ORfRzVmvYHLrLKN0HSc2Wc1h6K-cLQ4FQJfdTEBlrotNpG2Q851P2OCqSd7U1ezy67E2tHUa7RfnYL9S20bBAYmS42COLpTm8xfXZIOdjS8hOEX1WZCbQCS7gjCg?key=d_qWtjEes9qiiyogS_A3bw) +![](../../.gitbook/assets/sendgrid/sendgrid-login.png) * Navigate to API Key Settings:- * On the left-hand navigation panel, click on "Settings". * Under Settings, select "API Keys". -![](https://lh7-rt.googleusercontent.com/docsz/AD_4nXfy-IUcY6_BTto_2Glo7JSXnmXZVLrR2X8Oudv1F_Tf1CSzQ85Re0RxaSgyWGIgnLCqQsu1x2SRpkCLpfz-jRkDwBlgyz45Pp3Cuyhuf11a-K5NF5dC2LFhK7DdMEMFk0bMfq1hXg?key=d_qWtjEes9qiiyogS_A3bw) +![](../../.gitbook/assets/sendgrid/sendgrid-settings-api-keys.png) * Create a New API Key: * Click on the "Create API Key" button. -![](https://lh7-rt.googleusercontent.com/docsz/AD_4nXeKwFhpTjxrbEOEfo0ndl8bSfBpS1sPnGQgMQWOiU9Sv8qxseMDbVAyW3w5sjh23Ca6g6RK2LHVHHJREEDoT4xBZi_og7i8r5VPhR_f36NY4WTieqOaYW9ETGP7Y0h13-m3WyXN5A?key=d_qWtjEes9qiiyogS_A3bw) +![](../../.gitbook/assets/sendgrid/sendgrid-create-api-key.png) * Choose one of the following access levels: * Enter a meaningful name for your API key to help you identify its purpose later. @@ -121,12 +121,12 @@ Your SendGrid API key can optionally be stored in an OpenBao server instead of t * Billing Access – Provides access only to billing-related endpoints. * Click the "Create & View" button. -![](https://lh7-rt.googleusercontent.com/docsz/AD_4nXeCZQrz4sNPFaqjeUWQn7ZT8LirX49yNxW4keyaRlM14cFOG_XOR22LfvHTl8SFfDRyrNmvYOb5r751LGS8XfX0jLU-vel7gve-USCNRySOwBG8HDfkDETbJlxkJaszgwT0qFNUkw?key=d_qWtjEes9qiiyogS_A3bw) +![](../../.gitbook/assets/sendgrid/sendgrid-create-view.png) * Secure Your API Key: * Your API key will be displayed only once, make sure to copy and save this key securely in a password manager or secure vault. -![](https://lh7-rt.googleusercontent.com/docsz/AD_4nXfaxBTAD_RmN_r_uqStSpLpkId7A89_amkJuAOFv96TSB56tJ0mF7DGKwxfQqoOFN-FYaG0_MK12_nSWLnHUjCNsWT2rt9qT-l5GYNvFDJbX9TnoSn1ySlH6_FbEEeFLDyCq5SR?key=d_qWtjEes9qiiyogS_A3bw) +![](../../.gitbook/assets/sendgrid/sendgrid-key-reveal.png) \ Note:- @@ -179,7 +179,7 @@ This script will: * Launch all required services in separate terminal tabs (each tab will be automatically named for its service, and new services will start a few seconds apart) After the script completes, the backend and agent services will be running.\ -You will need to start the frontend separately by following the instructions [here](https://docs.credebl.id/docs/contribute/setup/studio). +You will need to start the frontend separately by following the instructions [here](../../contribute/setup/studio.md). #### Option 2: Docker Deployment @@ -279,8 +279,7 @@ Keycloak * #### **Access the CREDEBL API** -Once all containers are running, you can access the CREDEBL API\ - +Once all containers are running, you can access the CREDEBL API at [http://localhost:5000](http://localhost:5000). ### **Tearing Down the Infrastructure** diff --git a/getting-started/local-deployment/studio.md b/getting-started/local-deployment/studio.md index 7b768f7..83cda70 100644 --- a/getting-started/local-deployment/studio.md +++ b/getting-started/local-deployment/studio.md @@ -1,5 +1,5 @@ --- -description: Follow this guides to setup STUDIO locally - +description: Follow this guide to set up Studio locally icon: browsers --- @@ -18,12 +18,12 @@ cd studio * Create a .env file and set the required environment variables as per the `.env.demo` file. * Update the Keycloak credentials - * For older version (>v2.1.0) + * For versions before v2.1.0 * **`PUBLIC_KEYCLOAK_MANAGEMENT_CLIENT_SECRET`** - * For newer version (v2.1.0) + * For v2.1.0 and above * **`NEXT_PUBLIC_KEYCLOAK_MANAGEMENT_CLIENT_SECRET`** - You can get this value from your platform environment variables or directly from the Keyclock dashboard. + You can get this value from your platform environment variables or directly from the Keycloak dashboard. * In version v2.1.0, we have implemented NextAuth for SSO. To run the application, please refer to the `env.demo` file for the required NextAuth-related values. * `NEXTAUTH_SECRET` Generate this secret by referring [here](https://next-auth.js.org/configuration/options#nextauth_secret.) (Only for v 2.1.0). * Add the backend URL for `PUBLIC_ALLOW_DOMAIN` diff --git a/introduction/concepts.md b/introduction/concepts.md index fb980ed..97c9928 100644 --- a/introduction/concepts.md +++ b/introduction/concepts.md @@ -68,7 +68,7 @@ A credential definition (CRED\_DEF or CLAIM\_DEF) contains the public data neede ## Wallet -wallet is a digital application that securely stores and manages a user's verifiable credentials and decentralized identifiers (DIDs). It allows individuals to control their data, facilitating the issuance, storage, and sharing of identity information without relying on central authorities. Wallets provide users with an interface to interact with various services, enabling them to present their credentials selectively while maintaining privacy and security. +A wallet is a digital application that securely stores and manages a user's verifiable credentials and decentralized identifiers (DIDs). It allows individuals to control their data, facilitating the issuance, storage, and sharing of identity information without relying on central authorities. Wallets provide users with an interface to interact with various services, enabling them to present their credentials selectively while maintaining privacy and security. ### Edge Wallet diff --git a/introduction/features.md b/introduction/features.md index 7257f28..59d0346 100644 --- a/introduction/features.md +++ b/introduction/features.md @@ -19,7 +19,7 @@ CREDEBL enables end-to-end verifiable credential management with following key f ### **User Registration** -The platform provides an efficient user registration process through email-based verification. Furthermore, the platform offers modern & highly secure authentication mechanisms such as FIDO Passkey for phishing-resistent user verification. These measures establish a multi-layered approach to user authentication, mitigating the potential for unauthorized access and preserving the security of sensitive user data. Platform also provides highly secure mechanisms such as ClientId and ClientSecret for API authentication. +The platform provides an efficient user registration process through email-based verification. Furthermore, the platform offers modern & highly secure authentication mechanisms such as FIDO Passkey for phishing-resistant user verification. These measures establish a multi-layered approach to user authentication, mitigating the potential for unauthorized access and preserving the security of sensitive user data. Platform also provides highly secure mechanisms such as ClientId and ClientSecret for API authentication. ### **Organization Onboarding** @@ -51,9 +51,10 @@ Verifiable credentials (VCs) have these qualities: * Portability: You can easily send them to others online. * Verifiability: You can check who issued the credential, who holds it, if it’s unchanged, and if it’s valid. -* Privacy: You can choose what info to share using zero-knowledge proofs, giving you more control.Integrity: VCs can’t be changed or faked.” +* Privacy: You can choose what info to share using zero-knowledge proofs, giving you more control. +* Integrity: VCs can’t be changed or faked. -Verification credential Stake-holders: +Verifiable credential stakeholders: * Issuer: The entity that generates the Verifiable Credential and provides it to another entity. * Holder: The entity that possesses the verifiable credential in their digital wallet. diff --git a/introduction/use-cases.md b/introduction/use-cases.md index b4d86e1..5bb999c 100644 --- a/introduction/use-cases.md +++ b/introduction/use-cases.md @@ -15,7 +15,7 @@ description: >- * Boarding Pass, Passport, Visa, Work Authorization -### [Academic Digital Credentials](implementations.md#credebl-saas) +### [Academic Digital Credentials](implementations.md#sovio.id) * Student ID, Degree, Diploma, Transcripts, Bonafide, Transfer Certificate @@ -30,14 +30,3 @@ description: >- ### Life Events * Birth Certificate, Death Certificate, Marriage Certificate, etc - - - - - - - - - - - diff --git a/references/copyright-and-license.md b/references/copyright-and-license.md index 8be0d7f..816d430 100644 --- a/references/copyright-and-license.md +++ b/references/copyright-and-license.md @@ -5,8 +5,8 @@ icon: copyright # Copyright & License -`Copyright © CREDEBL a Series of LF Projects, LLC. All rights reserved.` +Copyright © CREDEBL, a Series of LF Projects, LLC. All rights reserved. -`This project is licensed under the`` `**`Apache License 2.0,`**`which permits users to freely use, modify, and distribute the software, provided that they adhere to the terms and conditions of the license. The Apache License 2.0 ensures that any derivative works must include a copy of the original license and acknowledge the original authors.` +This project is licensed under the Apache License 2.0, which permits users to freely use, modify, and distribute the software, provided that they adhere to the terms and conditions of the license. The Apache License 2.0 ensures that any derivative works must include a copy of the original license and acknowledge the original authors. For full details, you can review the [Apache License 2.0](https://github.com/credebl/platform/blob/main/LICENSE) to understand your rights and obligations when using or modifying this software. diff --git a/references/ecosystem/ecosystem.md b/references/ecosystem/ecosystem.md index 122219f..51b7fce 100644 --- a/references/ecosystem/ecosystem.md +++ b/references/ecosystem/ecosystem.md @@ -25,9 +25,6 @@ - 3.2.6.1 [Create Intent Notice](#3261-create-intent-notice) - 3.2.6.2 [Get Intent Notice by Intent ID](#3262-get-intent-notice-by-intent-id) - 3.2.6.3 [Update Intent Notice](#3263-update-intent-notice) - - 3.3 [Template](#33-template) - -4. [Cross-Ecosystem Access](#4-cross-ecosystem-access) --- @@ -632,7 +629,7 @@ GET /v1/intent/{intentId}/notice Updates an existing consent notice linked to a specific intent. Use this endpoint when the terms, policies, or data processing rules of a workflow have changed and the notice needs to reflect the latest information. -> **Note:** Updating a notice typically results in a new version being issued. Participants who previously accepted the older version may be may not effect, depending on the platform's consent management policy. +> **Note:** Updating a notice typically results in a new version being issued. Participants who previously accepted the older version may or may not be affected, depending on the platform's consent management policy. > **Role required:** Ecosystem Lead and Member @@ -650,5 +647,6 @@ PUT /v1/intent/{intentId}/notice --- +*Sections covering the credential **Template** registry and **Cross-Ecosystem Access** are planned for a future update.* *End of document* diff --git a/references/oid4vc/CREDEBL OID4VP Verifier API.md b/references/oid4vc/CREDEBL OID4VP Verifier API.md index a75269e..4aed246 100644 --- a/references/oid4vc/CREDEBL OID4VP Verifier API.md +++ b/references/oid4vc/CREDEBL OID4VP Verifier API.md @@ -307,7 +307,7 @@ Creates a VP request directly using a specified DCQL query and configuration, wi | Field | Type | Required | Description | |-------------------|--------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------| | `requestSigner` | object | Yes | Configuration for signing the VP request. See [Request Signer Object](#request-signer-object) below. | -| `dcql` | object | Yes | The DCQL query defining which credentials and claims are required from the holder. Follows the same structure as `templateJson.dcql.query` in the [Create Verification Template API](./create_verification_template_api.md). | +| `dcql` | object | Yes | The DCQL query defining which credentials and claims are required from the holder. Follows the same structure as `templateJson.dcql.query` in the [Create Verification Template API](#create-verification-template). | | `responseMode` | string | Yes | Defines how the holder's wallet should return the VP response. See [Response Modes](#response-modes) below. | | `expectedOrigins` | array | No | Array of allowed origin URLs. Required when `responseMode` is `dc_api` or `dc_api.jwt`. See [Expected Origins](#expected-origins) below. | diff --git a/references/oid4vc/OID4VC Issuer API.md b/references/oid4vc/OID4VC Issuer API.md index 0cc8513..788a921 100644 --- a/references/oid4vc/OID4VC Issuer API.md +++ b/references/oid4vc/OID4VC Issuer API.md @@ -425,7 +425,7 @@ The `appearance` object controls how the credential card is rendered in a wallet Creates a new credential offer for one or more Verifiable Credentials. The offer can be sent to a holder (wallet) who can then accept and receive the credentials. Both `dc+sd-jwt` and `mso_mdoc` credential formats are supported. -Two types of credential offers can be created: **Reach-out** (issuer initiates and sends the offer to the holder) and **Endor** (offer is generated for the holder to scan/accept). +Two types of credential offers can be created: **Reach-out** (issuer initiates and sends the offer to the holder) and **Endorser** (offer is generated for the holder to scan/accept). --- @@ -446,7 +446,7 @@ Two types of credential offers can be created: **Reach-out** (issuer initiates a |---------------------|--------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `credentials` | array | Yes | Array of credential objects to be issued as part of this offer. Multiple credentials can be included in a single offer. See [Credential Object](#credential-object) below. | | `authorizationType` | string | Yes | The authorization flow to use when the holder accepts the offer. See [Authorization Types](#authorization-types) below. | -| `noticeUrl` | string (URL) | No | If multiple credentials are included and their templates each carry their own notice URL, this field override that template based noticeUrl. | +| `noticeUrl` | string (URL) | No | If multiple credentials are included and their templates each carry their own notice URL, this field overrides the template-level `noticeUrl`. | --- @@ -455,7 +455,7 @@ Two types of credential offers can be created: **Reach-out** (issuer initiates a | Value | Description | |------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `preAuthorizedCodeFlow` | The offer is protected by a PIN. When the holder accepts the offer, they are prompted to enter a PIN to complete issuance. | -| `authorizationCodeFlow` | The holder must authenticate using a username and password against the IDP server configured for the issuer in the [Create Issuer API](./create_issuer_api.md) (`authorizationServerConfigs`). | +| `authorizationCodeFlow` | The holder must authenticate using a username and password against the IDP server configured for the issuer in the [Create Issuer API](#create-issuer) (`authorizationServerConfigs`). | --- @@ -465,7 +465,7 @@ Each entry in the `credentials` array represents a single credential to be issue | Field | Type | Required | Description | |----------------|--------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `templateId` | string | Yes | The UUID of the credential template to use. The template defines the credential format, attributes, signing option, and appearance. Refer to the [Create Template API](./create_credential_template_api.md). | +| `templateId` | string | Yes | The UUID of the credential template to use. The template defines the credential format, attributes, signing option, and appearance. Refer to the [Create Template API](#create-credential-template). | | `payload` | object | Yes | The claim data to embed in the credential. Structure varies by template format — see [Payload: dc+sd-jwt](#payload-dcsdjwt) and [Payload: mso_mdoc](#payload-mso_mdoc) below. | | `validityInfo` | object | Yes | Defines the validity period of the issued credential. See [Validity Info Object](#validity-info-object) below. | diff --git a/references/releases/v.2.1.0.md b/references/releases/v.2.1.0.md index b6f462d..1b0ff06 100644 --- a/references/releases/v.2.1.0.md +++ b/references/releases/v.2.1.0.md @@ -36,7 +36,7 @@ Encrypt your **raw** Agent API key using **AES** with `CRYPTO_PRIVATE_KEY`. You ### SSO (Single Sign-On) * Studio - * [NextAuth.js](http://nextauth.js) is used for implementing SSO. + * [NextAuth.js](https://next-auth.js.org) is used for implementing SSO. * To run the application, refer to the `env.demo` file for the required NextAuth-related values. * Make sure these values are added to your `.env` file. * Platform